Skip to main content
POST
Criar envelope
Cria um novo envelope, abre sessões de assinatura para cada signatário e retorna as URLs/tokens para compartilhamento.
string
required
Título do envelope (ex: "Contrato de Serviços 2025").
enum
required
Modo de assinatura: sequential (signatários assinam um de cada vez) ou parallel (todos podem assinar simultaneamente).
object
required
Documento a ser assinado (PDF).
array
required
Lista de signatários.
string
Código único externo do seu sistema (ex: "FAT-2025-001"). Deve ser único por projeto. Opcional.
string
UUID de um template para usar como base. Se enviado, o documento do template é ignorado; use o documento enviado aqui ou deixe vazio para usar o do template.
string
Data/hora limite para assinatura (ISO 8601, ex: "2025-12-31T23:59:59Z"). Signatários que não acessarem até essa data verão 410 Gone.
string
URL origem do seu app (ex: "https://app.seu-dominio.com"). Usado para construir links no e-mail de convite.
string
URL webhook para notificação de mudanças de estado (ex: "https://seu-backend.com/webhooks/status"). Opcional. Veja Notificações via webhook.
object
Dados de autenticação/verificação (usado para escolher estratégia de assinatura).

Respostas

string
UUID único do envelope criado.
string
UUID do arquivo (PDF) do envelope.
array
Lista de signatários com sessões abertas.
string
Estado inicial do envelope: CREATED.
string
Timestamp de criação (ISO 8601).

Erros comuns

Veja Autenticação e erros para detalhes sobre 401, 400, 409, etc.
  • 400: CPF inválido, email malformado, documento não encontrado (URL inválida).
  • 401: API key inválida ou expirada.
  • 409: externalCode duplicado no projeto.

Exemplo completo

Próximas etapas

  1. Compartilhe os links: Envie cada signUrl para o signatário correspondente (ou extraia o sessionToken e construa seu próprio link).
  2. Signatário assina: Veja GET /v1/sign/:sessionToken para entender o fluxo do signatário.
  3. Acompanhe o status: Use GET /v1/envelopes/:uuid para verificar mudanças de estado.