Documentação da API

Referência de endpoints, autenticação e payloads do LetsSign. Escolha uma API abaixo ou consulte os webhooks disponíveis.

V1 Partners API

v1

API para integrações de parceiros do LetsSign.

Ir para documentação

Também em OpenAPI JSON, Markdown e coleção Postman

V2 Partners API

v2

API para integrações de parceiros do LetsSign.

Ir para documentação

Também em OpenAPI JSON, Markdown e coleção Postman

Guias

O que a referência não conta: passo a passo, conceitos e limites. Comece pelo Quickstart.

Quickstart Da chave de integração à primeira assinatura concluída, em cinco passos com as requisições prontas. Autenticação e contas Como a chave do parceiro funciona, o que é uma conta, como descobrir o accountId e o que causa 401 e 403. Webhooks Cadastro de URLs, envelope, os dez eventos, contrato de entrega e como tratar repetições. Erros Formato Problem Details, o significado de cada status e o que vale repetir. Paginação e filtros Modelo de paginação da v2, filtros de cada listagem e o modelo legado da v1. Limites e features Features de plano exigidas por operação, cotas, tamanhos, prazos e caches. Ferramentas e agentes de IA Coleção Postman (também Bruno, Insomnia e Hoppscotch), servidor MCP a partir do OpenAPI, sandbox e como um agente deve operar a API. Migração da v1 para a v2 Os quatro endpoints substituídos, com o mapeamento de parâmetros e respostas. Changelog Mudanças no contrato e na documentação da Partners API, da mais recente para a mais antiga.

Webhooks

Notificações enviadas pelo LetsSign para a URL configurada na sua conta.

Método
POST
Content-Type
application/json
Resposta esperada
200 ou 202
Test Enviado no cadastro de uma URL de webhook, para verificar a disponibilidade 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "Test",
  "entity": {
    "test": true
  }
}
DocumentSentToSignature Documento enviado para assinatura 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "DocumentSentToSignature",
  "entity": {
    "documentId": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "sentAt": "2026-08-20T14:05:00Z",
    "signers": [
      {
        "id": "01991441-0a1b-7c2d-8e3f-4a5b6c7d8e9f",
        "role": "Parte",
        "authenticationMethod": "Email",
        "email": "maria.silva@exemplo.com.br",
        "name": "Maria da Silva"
      },
      {
        "id": "01991441-9f8e-7d6c-8b5a-4c3d2e1f0a9b",
        "role": "Testemunha",
        "authenticationMethod": "Email",
        "email": "joao.souza@exemplo.com.br",
        "name": "João de Souza"
      }
    ]
  }
}
SignerAddedToDocument Novo signatário adicionado ao documento 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "SignerAddedToDocument",
  "entity": {
    "documentId": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "signer": {
      "id": "01991441-9f8e-7d6c-8b5a-4c3d2e1f0a9b",
      "role": "Testemunha",
      "authenticationMethod": "Email",
      "email": "joao.souza@exemplo.com.br",
      "name": "João de Souza"
    }
  }
}
DocumentSignatureMember Signatário assinou o documento 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "DocumentSignatureMember",
  "entity": {
    "documentId": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "role": "Parte",
    "email": "maria.silva@exemplo.com.br",
    "name": "Maria da Silva",
    "signedAt": "2026-08-21T10:12:45Z"
  }
}
DocumentSignatureFinished Todos signatários assinaram o documento 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "DocumentSignatureFinished",
  "entity": {
    "id": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "status": "Finished",
    "signatureStatus": "Signed"
  }
}
DocumentStatusChanged Documento teve status alterado 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "DocumentStatusChanged",
  "entity": {
    "status": "NewVersionBase",
    "newVersionId": "0199144e-b8c9-7d0e-8f1a-2b3c4d5e6f7a",
    "id": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f"
  }
}
DocumentRemoved Documento foi removido 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "DocumentRemoved",
  "entity": {
    "id": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f"
  }
}
FormFilled Formulário foi preenchido 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "FormFilled",
  "entity": {
    "formId": "01991443-7d8e-7f9a-8b1c-2d3e4f5a6b7c",
    "documentId": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f"
  }
}
DocumentSignaturesExpired Prazo de assinatura do documento venceu 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "DocumentSignaturesExpired",
  "entity": {
    "deadlineForSignature": "2026-09-08T00:00:00Z",
    "id": "01991447-3c4d-7e5f-8a6b-7c8d9e0f1a2b",
    "documents": [
      {
        "id": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
        "pendingSigners": [
          {
            "id": "01991441-0a1b-7c2d-8e3f-4a5b6c7d8e9f",
            "role": "Parte",
            "authenticationMethod": "Email",
            "email": "maria.silva@exemplo.com.br",
            "name": "Maria da Silva"
          },
          {
            "id": "01991441-9f8e-7d6c-8b5a-4c3d2e1f0a9b",
            "role": "Testemunha",
            "authenticationMethod": "Email",
            "email": "joao.souza@exemplo.com.br",
            "name": "João de Souza"
          }
        ]
      }
    ]
  }
}
DocumentSignaturesCanceled Assinaturas do documento foram canceladas 
{
  "occurredAt": "2026-08-21T10:12:45Z",
  "accountId": "0199143a-7c2e-7b1a-9f2d-3c4b5a6d7e8f",
  "event": "DocumentSignaturesCanceled",
  "entity": {
    "id": "01991447-3c4d-7e5f-8a6b-7c8d9e0f1a2b",
    "documents": [
      {
        "id": "01991440-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
        "pendingSigners": [
          {
            "id": "01991441-0a1b-7c2d-8e3f-4a5b6c7d8e9f",
            "role": "Parte",
            "authenticationMethod": "Email",
            "email": "maria.silva@exemplo.com.br",
            "name": "Maria da Silva"
          },
          {
            "id": "01991441-9f8e-7d6c-8b5a-4c3d2e1f0a9b",
            "role": "Testemunha",
            "authenticationMethod": "Email",
            "email": "joao.souza@exemplo.com.br",
            "name": "João de Souza"
          }
        ]
      }
    ]
  }
}

Para ferramentas e modelos de IA

A documentação existe em texto, sem depender de JavaScript. Cada API acima tem o contrato em OpenAPI 3.1, a referência completa em Markdown e uma coleção Postman; os arquivos abaixo reúnem tudo. Para conectar um agente por MCP ou importar as requisições numa ferramenta, veja o guia Ferramentas e agentes de IA.

llms.txt
Índice curto com resumo e links para cada formato.
llms-full.txt
As referências de todas as APIs em um único Markdown.
docs/index.json
Lista dos documentos com versão, contagens e URLs, para descoberta automática.