SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Primeiro envelope em 5 minutos
      • 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 um cliente (SDK)
      • Webhooks — Evento ENVELOPE_SENT
      • Webhooks — Evento SIGNATORY_SIGNED
      • Webhooks — Evento ENVELOPE_COMPLETED
      • Webhooks — Evento ENVELOPE_VOIDED
      • Webhooks — Evento ENVELOPE_EXPIRED
      • Webhooks — Segurança e verificação
      • Webhooks — Entregas, retentativas e reenvio
      • Webhooks — Testar na Sandbox e automatizar
    • 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
        • 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
        • 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
        • Criar webhook
        • Listar webhooks
        • Atualizar webhook
      • 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
      • Auditoria e relatórios
        • 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

Webhooks — Evento SIGNATORY_SIGNED

Um signatário assinou. Chega um evento por assinatura: um envelope com três
signatários gera três SIGNATORY_SIGNED. Visão geral de todos os eventos em
Webhooks.

Quando dispara#

Quando um participante com papel de signatário assina, com assinatura
eletrônica ou com certificado ICP-Brasil.
Também na assinatura em lote: cada envelope assinado no lote gera o seu
próprio evento.
Quando o participante é um grupo (ex.: "Diretoria"), quando a pessoa do grupo
assina por ele.
Quando o signatário assina de novo depois de um ajuste do envelope: chega
outro evento com o mesmo signatory.id e um signedAt novo.

Quando NÃO dispara#

Aprovações não geram este evento: aprovador não é signatário.
Observadores e demais papéis sem assinatura.
Recusa de assinatura.

Exemplo de payload#

Participante individual:
{
  "id": "e5f6a7b8-0000-4000-8000-000000000020",
  "event": "SIGNATORY_SIGNED",
  "createdAt": "2026-09-14T09:00:02.000Z",
  "data": {
    "envelope": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "SENT"
    },
    "signatory": {
      "id": "7a9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Pessoa Exemplo",
      "email": "pessoa@example.com",
      "method": "ELECTRONIC",
      "signedAt": "2026-09-14T09:00:00.000Z"
    }
  }
}
Participante de grupo (traz signedBy):
{
  "id": "d4c3b2a1-0000-4000-8000-000000000002",
  "event": "SIGNATORY_SIGNED",
  "createdAt": "2026-09-14T10:00:02.000Z",
  "data": {
    "envelope": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "SENT"
    },
    "signatory": {
      "id": "0b1c2d3e-4f50-4a61-8b72-93a4b5c6d7e8",
      "name": "Diretoria",
      "email": null,
      "method": "ELECTRONIC",
      "signedAt": "2026-09-14T10:00:00.000Z",
      "signedBy": {
        "name": "Pessoa Exemplo",
        "email": "pessoa@example.com"
      }
    }
  }
}

Campos de data#

CampoTipoDescrição
envelope.idstring (UUID)Id do envelope.
envelope.statusstringStatus no momento em que a entrega foi montada. Na última assinatura pode já vir COMPLETED.
signatory.idstring (UUID)Id do participante no envelope, o mesmo do GET da API.
signatory.namestring ou nullNome registrado na assinatura (em grupo, o nome do grupo).
signatory.emailstring ou nullE-mail registrado na assinatura (em grupo, o do grupo — pode ser null).
signatory.methodstringELECTRONIC (assinatura eletrônica) ou PKI (certificado ICP-Brasil).
signatory.signedAtstring (ISO 8601, UTC)Quando a assinatura foi registrada.
signatory.signedByobjetoSó quando o participante é um grupo: a pessoa do grupo que de fato assinou. Para participante individual o campo não aparece.
signatory.signedBy.namestring ou nullNome de quem assinou pelo grupo.
signatory.signedBy.emailstring ou nullE-mail de quem assinou pelo grupo.
O formato externo (id, event, createdAt, environment) e os cabeçalhos
estão em Webhooks → Payload.

O que fazer com ele#

Atualizar o andamento no seu sistema ("2 de 3 assinaram").
Guardar o signedAt mais recente por signatory.id: depois de um ajuste o
mesmo signatário pode assinar de novo.
Não use este evento para saber que o envelope terminou. Na última assinatura,
o ENVELOPE_COMPLETED pode chegar antes ou depois deste evento — não
dependa da ordem; espere o ENVELOPE_COMPLETED.
Modificado em 2026-10-01 21:37:30
Página anterior
Webhooks — Evento ENVELOPE_SENT
Próxima página
Webhooks — Evento ENVELOPE_COMPLETED
Built with