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_COMPLETED

Todas as ações do envelope terminaram e ele chegou a COMPLETED. É o evento para
buscar os documentos assinados. Visão geral de todos os eventos em
Webhooks.

Quando dispara#

Depois que todos os participantes concluem suas ações (assinaturas e aprovações)
e os documentos são selados. Quando o evento chega, a versão assinada dos
documentos já está disponível para download.
Vale para envelopes com assinatura eletrônica, com certificado ICP-Brasil ou com
os dois.

Quando NÃO dispara#

Enquanto ainda falta alguma ação: cada assinatura intermediária gera só
SIGNATORY_SIGNED.
Em envelope anulado ou expirado (veja
ENVELOPE_VOIDED e
ENVELOPE_EXPIRED).
Em casos raros o mesmo envelope pode gerar mais de um ENVELOPE_COMPLETED, por
exemplo, quando um documento já concluído precisa ser selado de novo. Elimine
entregas repetidas pelo id do evento, conforme o guia de
entregas e retentativas.
Use data.envelope.id para relacionar o evento ao envelope, e não para descartar
um novo evento de conclusão de um envelope já processado.

Exemplo de payload#

{
  "id": "9d4fb916-5ab7-4a49-9014-1249345f1c6c",
  "event": "ENVELOPE_COMPLETED",
  "createdAt": "2026-09-03T18:30:00.000Z",
  "data": {
    "envelope": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "COMPLETED",
      "completedAt": "2026-09-03T18:29:58.000Z"
    },
    "documents": [
      {
        "id": "2f1c5d8d-97dd-40a8-aefe-1eec9d17e301",
        "name": "contrato.pdf",
        "originalFileHash": "4f6f53d15ea7ed8cb002f85d2cb1f6c0f2bd5861d89fc3f9f30670ecf40cb3d2",
        "sealedFileHash": "9b2e6c0a1d4f8e3b7a5c2d9f0e1b4a6c8d3f5e7a9b1c2d4e6f8a0b3c5d7e9f1a"
      }
    ],
    "signatories": [
      {
        "id": "7a9e6679-7425-40de-944b-e07fc1f90ae7",
        "name": "Pessoa Exemplo",
        "email": "pessoa@example.com",
        "phoneNumber": null,
        "signedAt": "2026-09-03T18:25:00.000Z"
      }
    ]
  }
}

Campos de data#

CampoTipoDescrição
envelope.idstring (UUID)Id do envelope.
envelope.statusstringCOMPLETED.
envelope.completedAtstring (ISO 8601, UTC)Quando o envelope foi concluído.
documentsarrayOs documentos do envelope.
documents[].idstring (UUID)Id do documento - use no download.
documents[].namestringNome original do arquivo enviado.
documents[].originalFileHashstring ou nullHash SHA-256 (hexadecimal) do arquivo enviado, antes da assinatura.
documents[].sealedFileHashstring ou nullHash SHA-256 (hexadecimal) do arquivo selado (o assinado) - o que a verificação pública confere. Na selagem normal vem sempre preenchido; null só em documento cujo selado não tem hash registrado (legado ou selagem indisponível).
signatoriesarrayTodos os participantes do envelope (inclusive aprovadores e observadores), não só os signatários.
signatories[].idstring (UUID)Id do participante no envelope.
signatories[].namestring ou nullNome do participante.
signatories[].emailstring ou nullE-mail do participante.
signatories[].phoneNumberstring ou nullTelefone do participante, quando informado.
signatories[].signedAtstring (ISO 8601, UTC) ou nullQuando o participante assinou; null para quem não assina (ex.: aprovador, observador).
Por compatibilidade com integrações existentes, signatories neste evento lista
todos os participantes, e não só os signatários como nos demais eventos.
Para quem já assinou ou aprovou, name, email e phoneNumber são os
gravados no momento do ato, e não o cadastro atual do participante. Se o ato não
registrou e-mail ou telefone, o campo vem null.
O formato externo (id, event, createdAt, environment) e os cabeçalhos
estão em Webhooks → Payload.

O que fazer com ele#

1.
Confirme pela API (recomendado para ação irreversível):
GET /v4/api/envelopes/{envelopeId} deve mostrar COMPLETED.
2.
Baixe os documentos assinados. Para um documento:
O parâmetro type é obrigatório: signed (assinado) ou original. Ou baixe
todos de uma vez, em ZIP, com GET /v4/api/envelopes/{envelopeId}/download.
A rota de documento devolve só { "url" }, com validade de 15 minutos. A do
envelope (ZIP) devolve { "url", "expiresAt", "fileName" }, e a url vale para
um único download e expira em 60 segundos. Em ambos os casos a url é
temporária - baixe o arquivo logo e não a guarde nem a registre em log.
3.
Guarde o arquivo no seu sistema e marque o processo como concluído.
Para conferir a integridade:
o arquivo que você enviou corresponde a documents[].originalFileHash;
o arquivo assinado que você baixou corresponde a documents[].sealedFileHash.
É este hash que a verificação pública confere.
Reselagem. Se o envelope for selado de novo, chega um novo
ENVELOPE_COMPLETED com sealedFileHash novo. Preserve os arquivos e hashes
das versões anteriores, associados ao documento e ao evento que os informou.
As entregas não têm ordem garantida: não substitua a versão atual apenas porque
um evento chegou depois. Antes de atualizar o arquivo usado pelo seu sistema,
reconcilie o estado pela API e confira o hash do arquivo assinado obtido no
download atual. Se ele não corresponder ao hash do evento, não atribua esse
arquivo à versão descrita pelo evento.
O hash de uma versão anterior pode deixar de corresponder ao registro atual da
verificação pública. Essa diferença, por si só, não demonstra invalidade da
assinatura criptográfica ou perda de validade jurídica do PDF anterior.
Modificado em 2026-11-15 14:38:01
Página anterior
Evento SIGNATORY_SIGNED
Próxima página
Evento ENVELOPE_VOIDED
Built with