Eventos do Documento
Quando ocorrerem eventos nos documentos da sua conta, uma requisição HTTP POST pode ser disparada para a URL cadastrada no webhook. Para contexto geral, consulte Introdução a Webhooks e Segurança de Webhooks. Para cadastro, veja Cadastro de Webhooks.
Use os nomes abaixo exatamente como indicados ao configurar os eventos no cadastro do webhook (via APP ou API).
Na coluna Detalhes, o link leva à página com descrição e exemplo de payload do evento.
Ciclo de vida do documento
| Evento | Descrição | Detalhes |
|---|---|---|
upload | Ocorre quando é realizado o upload de um documento. | Ver |
add_image | Ocorre quando é adicionada uma imagem ao documento. | Ver |
close | Ocorre quando um documento é finalizado manualmente. | Ver |
auto_close | Ocorre quando um documento é finalizado automaticamente logo após a última assinatura. | Ver |
deadline | Ocorre quando a data limite de assinatura é atingida. | Ver |
document_closed | Ocorre quando um documento é finalizado e está pronto para download. | Ver |
cancel | Ocorre quando um documento é cancelado manualmente. | Ver |
Signatários e assinatura
| Evento | Descrição | Detalhes |
|---|---|---|
add_signer | Ocorre quando são adicionados signatários a um documento. | Ver |
remove_signer | Ocorre quando são removidos signatários de um documento. | Ver |
sign | Ocorre quando um signatário assina um documento. | Ver |
signature_started | Ocorre quando o fluxo de assinatura é iniciado por um signatário. | — |
refusal | Ocorre quando um documento é recusado. | Ver |
Autenticação, qualificação e tentativas
| Evento | Descrição | Detalhes |
|---|---|---|
attempts_by_whatsapp_exceeded | Ocorre quando as tentativas de reenvio de token via WhatsApp são excedidas. | Ver |
attempts_by_liveness_or_facematch_exceeded | Ocorre quando as tentativas de autenticação via selfie dinâmica ou biometria facial são excedidas. | Ver |
liveness_refused | Ocorre quando a análise da prova de vida é recusada. | Ver |
facematch_refused | Ocorre quando a análise da biometria facial é recusada. | — |
biometric_refused | Ocorre quando a análise da biometria facial (SERPRO) é recusada. | — |
documentscopy_refused | Ocorre quando a análise de documentoscopia é recusada. | — |
ocr_refused | Ocorre quando a análise de OCR é recusada. | — |
Configuração do documento
| Evento | Descrição | Detalhes |
|---|---|---|
update_deadline | Ocorre quando a data limite de assinatura de um documento é alterada. | Ver |
update_auto_close | Ocorre quando a opção de finalização automática de um documento é alterada. | Ver |
update_locale | Ocorre quando o idioma de um documento é alterado. | — |
custom | Ocorre em fluxos de eventos customizados (por exemplo, envio de token por e-mail ou SMS). | Ver |
Aceite via WhatsApp
Estes eventos referem-se ao fluxo de Aceite via WhatsApp. A listagem completa e as descrições oficiais estão em Eventos do Aceite via WhatsApp.
| Evento | Descrição | Detalhes |
|---|---|---|
acceptance_term_enqueued | Aceite enfileirado para envio. | Ver |
acceptance_term_sent | Aceite enviado ao destinatário. | Ver |
acceptance_term_completed | Aceite concluído com sucesso. | Ver |
acceptance_term_refused | Aceite recusado pelo destinatário. | Ver |
acceptance_term_canceled | Aceite cancelado. | Ver |
acceptance_term_expired | Aceite expirado. | Ver |
acceptance_term_error | Erro no processamento do aceite. | Ver |
Próximos passos
- Cadastro via API: Cadastro de Webhooks via API (ajuste o slug se a URL oficial for outra na sua versão do portal).
- Exemplos dos campos
documentesignatáriosnos payloads: Exemplo do campo Document e Exemplo do campo Signers (conforme páginas vinculadas nos artigos de cada evento).
❓Precisa de ajuda? Entre em contato com o Suporte
💰Dúvida sobre planos e preços? Veja o comparativo
🔍Não sabe qual versão está usando? Descubra a sua versão
📚Respostas rápidas? Visite nosso FAQ
Updated 8 days ago