Assinatura digital (API)
A API de Assinatura digital permite cadastrar documentos PDF, indicar os destinatários e os campos de assinatura, enviar o documento para assinatura e acompanhar o andamento. Corresponde às telas Documentos e Dashboard do módulo Assinatura digital. Como cada tela funciona, veja o manual do módulo Assinatura digital.
Os endpoints exigem o pacote Assinatura digital na empresa cliente. Sem o pacote, o cadastro de documentos é recusado.
Recursos
| Recurso | Tela | Página |
|---|---|---|
| Documentos | Documentos | Documentos |
| Destinatários | Detalhe do documento | Destinatários |
| Observadores | Detalhe do documento | Observadores |
| Campos de assinatura | Detalhe do documento | Campos de assinatura |
| Etiquetas | Documentos e Detalhe do documento | Etiquetas |
| Histórico | Detalhe do documento | Histórico |
| Consulta de status em lote | Documentos | Consulta de status em lote |
| Status | Documentos (filtros e totais) | Status |
| Dashboard | Dashboard | Dashboard |
Fluxo de envio
- Cadastre o documento com
POST /digital-signature/documents. Ele fica em Aguardando envio. - Cadastre pelo menos um destinatário com
POST /digital-signature/documents/{document_uuid}/recipients. - Se quiser, posicione os campos de assinatura com
PUT /digital-signature/documents/{document_uuid}/fields, e ajuste os parâmetros comPUT /digital-signature/documents/{uuid}/parameters. - Envie o documento com
PATCH /digital-signature/documents/{uuid}/send-to-sign. Cada destinatário recebe o link de assinatura pelos canais cadastrados. - Acompanhe o andamento. O status e as datas de abertura e assinatura são
atualizados quando o provedor informa cada etapa. Também é possível consultar
na hora com
PATCH /digital-signature/documents/{uuid}/check-status.
As regras gerais (endereço base, formato das respostas, paginação, erros) estão em Convenções.