Skip to main content
POST
Criar rascunho de assinatura incremental
Cria a assinatura incremental em rascunho, no estado “Enviar arquivos”, sem documento nem signatário. Ninguém é avisado até o send. Cada passo seguinte fica gravado no rascunho, então quem monta o pedido numa tela pode recarregar a página sem perder nada. Para criar e enviar em uma única chamada, use POST /signer/v1/incremental-signatures. As regras do modo incremental estão em Assinatura incremental.

Parâmetros

string
required
Título, ex.: "CCB 2026-0001". Máximo 255 caracteres.
string
required
Vencimento (ISO 8601). Precisa estar no futuro.
integer
Frequência dos lembretes, em horas. Padrão: 24.
enum
sequential (na ordem da lista) ou parallel (todos ao mesmo tempo). Padrão: parallel. Não muda depois de criado o rascunho.
enum
EMAIL, SMS ou NONE. Com NONE ninguém é avisado e urlNotification passa a ser obrigatória.
string
URL HTTPS que recebe os eventos (SENT, SIGNED, REFUSED, FINISHED, CANCELLED e EXPIRED). Obrigatória com notificationChannel=NONE.

Respostas

string
Identificador do rascunho. Use-o nas chamadas seguintes.
integer
Estado do rascunho: 1 Enviar arquivos, 3 Inserir signatários, 4 Posicionar assinatura, 5 Conferência, 6 Aguardando assinatura.
string
Nome do estado.
string
Título.
string
Vencimento (ISO 8601).
integer
Frequência dos lembretes, em horas.
string
sequential ou parallel.
string
EMAIL, SMS ou NONE.
string
Webhook, ou null.
string
Criação (ISO 8601).

Erros

Veja Autenticação e erros.
  • 400: Título vazio, vencimento no passado ou canal inválido.

Exemplo

Os passos

  1. Enviar arquivos: POST .../:uuid/documents, um por chamada. Depois, advance.
  2. Inserir signatários: PUT .../:uuid/signers. Depois, advance.
  3. Posicionar assinatura: placement-mode e position de cada signatário. Depois, advance.
  4. Conferência: send.
Para corrigir algo antes do envio, use PATCH .../:uuid/settings ou POST .../:uuid/back.