API Reference — Visão geral

Recursos cobertos:

• Documentos — criar, anexar, enviar, baixar, cancelar
• Templates — modelos com variáveis
• Webhooks — cadastro e gerenciamento

Recursos relacionados:

• Autenticação — headers, escopos
• Webhooks — validação HMAC — verificar assinatura no lado seu
• Códigos de erro

Convenções

Formato de payloads

Todos os endpoints aceitam e devolvem application/json (com exceção do upload de PDF que é multipart/form-data). Datas em ISO-8601 com offset ("2026-05-23T14:30:00-03:00").

IDs

documentId, signerId, templateId são long (inteiro 64-bit). Não confunda documentId (o envelope) com o ID do arquivo PDF anexado.

Paginação

Endpoints GET em coleções aceitam ?page=N&pageSize=M (default page=1, pageSize=20, max 100). Resposta:

{
  "items": [...],
  "page": 1,
  "pageSize": 20,
  "total": 137
}

Erros (RFC 7807)

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.4",
  "title": "document.not_found",
  "status": 404,
  "detail": "Documento 12345 não encontrado.",
  "traceId": "00-abc...-01"
}

Sempre logue o traceId — usamos pra correlacionar nos nossos logs se você abrir um ticket.

Rate limit

60 requests/min por API key. Resposta 429 Too Many Requests traz Retry-After em segundos. Implemente backoff exponencial.