API do E-Signature

16 endpoints em 4 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

17 endpoints

Configurações de provedor

/e-signature/api/v1/esignature/provider-configs7

POST/e-signature/api/v1/esignature/provider-configsCria configuração e cifra as credenciais. Responde 201ESIGNATURE_ADMIN
GET/e-signature/api/v1/esignature/provider-configsLista as configurações da organizaçãoESIGNATURE_READ
GET/e-signature/api/v1/esignature/provider-configs/:idBusca uma configuração (sem as credenciais)ESIGNATURE_READ
PATCH/e-signature/api/v1/esignature/provider-configs/:idAtualiza nome, credenciais, ajustes ou estadoESIGNATURE_ADMIN
DELETE/e-signature/api/v1/esignature/provider-configs/:idExclusão lógica. Responde 204ESIGNATURE_ADMIN
POST/e-signature/api/v1/esignature/provider-configs/:id/testTesta a conexão com o provedorESIGNATURE_ADMIN
POST/e-signature/api/v1/esignature/provider-configs/:id/set-defaultMarca como padrão e desmarca as demaisESIGNATURE_ADMIN

/e-signature/api/v1/esignature/requests8

POST/e-signature/api/v1/esignature/requestsCria a solicitação a partir de um arquivo. Responde 201ESIGNATURE_CREATE
POST/e-signature/api/v1/esignature/requests/from-templateCria a partir de um template **do provedor**. Responde 201ESIGNATURE_CREATE
GET/e-signature/api/v1/esignature/requestsLista solicitações, paginadoESIGNATURE_READ
GET/e-signature/api/v1/esignature/requests/:idBusca a solicitação com os signatáriosESIGNATURE_READ
POST/e-signature/api/v1/esignature/requests/:id/cancelCancela a solicitaçãoESIGNATURE_CREATE
POST/e-signature/api/v1/esignature/requests/:id/resendReenvia a todos ou a um signatárioESIGNATURE_CREATE
GET/e-signature/api/v1/esignature/requests/:id/downloadURL do documento assinado. Exige COMPLETEDESIGNATURE_READ
DELETE/e-signature/api/v1/esignature/requests/:idExclusão lógica. Responde 204ESIGNATURE_DELETE

/e-signature/api/v1/esignature/webhooks1

POST/e-signature/api/v1/esignature/webhooks/:configIdRecebe evento do provedor**Pública** — sem JWT. Ver §14 e §15

/e-signature/health1

GET/e-signature/healthSonda de disponibilidade. Pública, não contabilizada nas 16 rotas