SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Crie seu primeiro envelope no Sandbox
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
      • Criar um envelope a partir de um modelo
      • Gerar cliente com OpenAPI
      • Evento ENVELOPE_SENT
      • Evento SIGNATORY_SIGNED
      • Evento ENVELOPE_COMPLETED
      • Evento ENVELOPE_VOIDED
      • Evento ENVELOPE_EXPIRED
      • Segurança e verificação
      • Entregas, retentativas e reenvio
      • Testar na Sandbox e automatizar
      • Conceitos da API V4
      • Posicionar campos por texto âncora
      • Verificar um documento selado
      • Evento PARTICIPANT_DECLINED
      • Evento EMAIL_BOUNCED
      • Entrega do convite pela integração
      • Evento PARTICIPANT_VIEWED
      • Guia completo da API V4
      • Assinatura embutida (sob consulta)
      • Salvar os documentos assinados no seu Drive
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Listar chamadas da própria chave
        • Consultar consumo do ciclo
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar e enviar envelope numa chamada
        • Gerar URL de download do envelope em ZIP
        • Duplicar envelope
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Consultar envelope
        • Mover envelope para outra pasta
        • Anular envelope
      • Participantes
        • Listar participantes do envelope
        • Aprovar participante aprovador
        • Recusar como participante aprovador
        • Corrigir contato do participante
        • Consultar link de assinatura
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Confirmar o PDF convertido de um DOCX
        • Validar um documento selado
        • Reordenar documentos do envelope
        • Consultar o tamanho das páginas
        • Achar texto (âncora) no documento
        • Verificar um documento selado
        • Baixar o PDF de exemplo
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Atualizar contato parcialmente
        • Listar envelopes do contato
        • Listar listas de contatos
        • Consultar lista de contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar grupos da conta
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Listar todas as pastas
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Listar entregas de um webhook
        • Detalhar uma entrega de webhook
        • Reenviar uma entrega de webhook
        • Girar o segredo de assinatura do webhook
        • Enviar um evento de teste para o webhook
        • Atualizar webhook
        • Criar webhook
        • Listar webhooks
      • Modelos
        • Listar modelos
        • Consultar modelo
        • Criar envelope a partir de modelo
        • Criar modelo em rascunho
        • Editar título e descrição do modelo
        • Consultar processamento do documento do modelo
        • Ativar modelo
        • Duplicar modelo
        • Enviar documentos do modelo
        • Definir vagas do modelo
        • Posicionar campos no documento do modelo
        • Apagar modelo em rascunho
        • Reordenar documentos do modelo
        • Remover documento do modelo
        • Definir cópias do modelo
        • Achar texto (âncora) no documento do modelo
      • Auditoria e relatórios
        • Relatório de consumo do plano
        • Relatório de recusas, anulações e prazos vencidos
        • Listar envelopes anulados
        • Relatório de envelopes
        • Relatório de uso por grupo
      • Etiquetas
        • Aplicar etiqueta ao envelope
        • Remover etiqueta do envelope
        • Listar etiquetas da conta
  1. Introdução

Evento ENVELOPE_SENT

O envelope passou a circular: os participantes já podem receber o convite e
assinar. Visão geral de todos os eventos em Webhooks.

Quando dispara#

Envio de um envelope que estava em rascunho, pela tela ou pela API
(POST /v4/api/envelopes/{envelopeId}/send, ou criação a partir de modelo com
send: true).
Reenvio depois de um ajuste: o envelope foi interrompido para correção e
enviado de novo. Cada reenvio gera um novo ENVELOPE_SENT.
Prazo estendido de um envelope expirado: ao estender o prazo de um envelope
em EXPIRED, ele volta a SENT e este evento é enviado.
Envelope com certificado ICP-Brasil: quando todos os participantes
assinam com certificado ICP-Brasil, os documentos passam antes por uma
preparação. O ENVELOPE_SENT sai quando essa preparação termina e o envelope de
fato começa a circular, e não no instante do pedido de envio.

Quando NÃO dispara#

Ao criar ou editar um rascunho.
Ao estender o prazo de um envelope que ainda estava circulando (não
expirado): não há mudança de estado.
Ao reenviar o convite (lembrete) a um participante: o envelope já estava
circulando.

Exemplo de payload#

{
  "id": "a7e1c2d3-0000-4000-8000-000000000010",
  "event": "ENVELOPE_SENT",
  "createdAt": "2026-09-13T13:00:02.000Z",
  "data": {
    "envelope": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "SENT",
      "occurredAt": "2026-09-13T13:00:00.000Z"
    },
    "signatories": [
      {
        "id": "7a9e6679-7425-40de-944b-e07fc1f90ae7",
        "name": "Pessoa Exemplo",
        "email": "pessoa@example.com"
      },
      {
        "id": "0b1c2d3e-4f50-4a61-8b72-93a4b5c6d7e8",
        "name": "Diretoria",
        "email": null
      }
    ]
  }
}

Campos de data#

CampoTipoDescrição
envelope.idstring (UUID)Id do envelope, o mesmo de GET /v4/api/envelopes/{envelopeId}.
envelope.statusstringStatus do envelope no momento em que a entrega foi montada. Normalmente SENT, mas pode já ter mudado (ex.: VOIDED se foi anulado logo em seguida). Use o event para saber o que aconteceu.
envelope.occurredAtstring (ISO 8601, UTC)Quando o envio aconteceu.
signatoriesarraySó os participantes com papel de signatário, na ordem de assinatura do envelope. Aprovadores e observadores não aparecem.
signatories[].idstring (UUID)Id do participante no envelope.
signatories[].namestring ou nullNome do participante (em um grupo, o nome do grupo).
signatories[].emailstring ou nullE-mail do participante, quando houver.
O formato externo (id, event, createdAt, environment) e os cabeçalhos
estão em Webhooks → Payload.

O que fazer com ele#

Consultar GET /v4/api/envelopes/{envelopeId} antes de atualizar o estado no
seu sistema. O evento informa que houve um envio; a entrega pode chegar
depois de outras mudanças, e as entregas não têm ordem garantida.
Se o estado atual confirmado for SENT, marcar o documento como
aguardando assinatura. Se você já tinha tratado um ENVELOPE_EXPIRED como
fim, pode voltar o processo para "em andamento" após essa confirmação.
Não reabrir um processo com estado posterior confirmado, como VOIDED, apenas
porque chegou um ENVELOPE_SENT atrasado.
Depois de um reenvio após ajuste, usar a consulta também para obter os
participantes e documentos atualizados.
Para compartilhar o link de um signatário por um canal próprio, use o
signatories[].id deste evento em
GET /v4/api/envelopes/{envelopeId}/participants/{participantId}/signing-link
somente se esse participante foi enviado com deliveryMethod: API, com uma
chave que tenha signing-links:read e opt-in habilitado na conta. Os demais
canais recebem 404 nessa rota. O link é uma credencial privada
e pode mudar após a edição do participante. Consulte novamente antes de
compartilhá-lo. A URL não é enviada no webhook.
Modificado em 2026-11-15 14:38:01
Página anterior
Gerar cliente com OpenAPI
Próxima página
Evento SIGNATORY_SIGNED
Built with