V1 Partners API

API para integrações de parceiros do LetsSign

V2 Partners API

API para integrações de parceiros do LetsSign

Webhooks:
Http method Content-Type Evento Corpo da requisição
POST application/json Quando uma URL é cadastrada e antes de todo envio de payload para teste de disponibilidade da URL cadastrada { "occurredAt": "2025-12-18T03:56:03.8058481Z", "accountId": "019b2f99-bf5d-7fb4-bf9d-16f8a59a7c27", "event": "Test", "entity": { "test": true } }

                                
POST application/json Documento enviado para assinatura { "occurredAt": "2025-12-18T03:56:03.8058539Z", "accountId": "019b2f99-bf5d-707e-84c0-f4a8902800a8", "event": "DocumentSentToSignature", "entity": { "documentId": "019b2f99-bf5d-7d23-8496-cb5342079a80", "sentAt": "2025-12-18T03:56:03.805856Z", "signers": [ { "id": "019b2f99-bf5d-7dc2-9724-40156cc08f0b", "role": "Parte", "authenticationMethod": "Email", "email": "signer@mail.com", "name": "Signer Name" } ] } }

                                
POST application/json Novo signatário adicionado ao documento { "occurredAt": "2025-12-18T03:56:03.805859Z", "accountId": "019b2f99-bf5d-7aa0-9493-1d5e6ca192a2", "event": "SignerAddedToDocument", "entity": { "documentId": "019b2f99-bf5d-7c98-846e-b7ca8279fa24", "signer": { "id": "019b2f99-bf5d-7ff4-9a76-f880085e579d", "role": "Parte", "authenticationMethod": "Email", "email": "signer@mail.com", "name": "Signer Name" } } }

                                
POST application/json Signatário assinou o documento { "occurredAt": "2025-12-18T03:56:03.8058599Z", "accountId": "019b2f99-bf5d-7f9e-9f5c-6247e94f7dca", "event": "DocumentSignatureMember", "entity": { "documentId": "019b2f99-bf5d-70b1-81ab-9752f0de1964", "role": "Parte", "email": "signer@mail.com", "name": "Signer Name", "signedAt": "2025-12-18T03:56:03.8058614Z" } }

                                
POST application/json Todos signatários assinaram o documento { "occurredAt": "2025-12-18T03:56:03.8059823Z", "accountId": "019b2f99-bf5d-7df2-8204-ff2e0741dce1", "event": "DocumentSignatureFinished", "entity": { "id": "019b2f99-bf5d-7516-899f-3f14961f6e44", "status": "Approved", "signatureStatus": "Signed" } }

                                
POST application/json Documento teve status alterado { "occurredAt": "2025-12-18T03:56:03.8059864Z", "accountId": "019b2f99-bf5d-75f0-a0f0-5f9224a4c2aa", "event": "DocumentStatusChanged", "entity": { "status": "NewVersionBase", "newVersionId": "019b2f99-bf5d-71f0-b419-d8b41fca4010", "id": "019b2f99-bf5d-752f-aeb3-7e1b431031a0" } }

                                
POST application/json Documento foi removido { "occurredAt": "2025-12-18T03:56:03.8059906Z", "accountId": "019b2f99-bf5d-756a-9c44-0c6c73d7e622", "event": "DocumentRemoved", "entity": { "id": "019b2f99-bf5d-7e2e-a453-731f175344e2" } }

                                
POST application/json Formulário foi preenchido { "occurredAt": "2025-12-18T03:56:03.8059915Z", "accountId": "019b2f99-bf5d-7459-94a2-fe88b0bd0760", "event": "FormFilled", "entity": { "formId": "019b2f99-bf5d-7f74-a341-2d872f425847", "documentId": "019b2f99-bf5d-716e-b869-f4b63333a562" } }