Enviar um documento para assinatura

POST 
/documents

Cria o documento e já envia, na mesma chamada — não existe rascunho por esta API. Se algum destinatário não puder ser convidado (franquia esgotada, por exemplo), nada é enviado e o documento não fica pendurado esperando um segundo passo: veja os possíveis 422 abaixo.

Sem fields, assina por selo, aplicado ao documento inteiro — é o caminho mais simples para quem só quer "manda pra alguém assinar". Para posicionar assinatura, rubrica ou campo de texto em um ponto específico da página, use fields — cada campo aponta para um destinatário por recipient_index (a posição dele em recipients, começando em 0), não por id: o id só existe depois que o destinatário é criado, e as duas coisas acontecem na mesma chamada.

Campo de assinatura tem tamanho mínimo — 180 x 56 pontos do PDF, que é o tamanho do carimbo desenhado sobre ele. Um campo menor é 422 e nada é criado. Veja width no schema SignatureFieldInput para a conversão para a sua régua.

A resposta sempre traz, para cada destinatário: id, email, phone e signing_url — o link de assinatura, que só aparece AQUI (veja o campo no schema de DocumentRecipient para o porquê). Use notify_recipients: false se preferir entregar esse link você mesmo, sem o Firmou avisar ninguém por e-mail ou WhatsApp.

Request

Responses

201

Documento criado e enviado.

401

Token ausente, inexistente, revogado ou vencido.

403

A conta não tem plano ativo, ou foi encerrada. O corpo diz o motivo em reason (no_active_plan ou account_closed).

422

Validação recusada, ou o envio não pôde ser concluído (franquia esgotada, campo de assinatura menor que o mínimo, PDF já veio assinado e pediu para anexar comprovante de novo, etc). O message explica o motivo; campo pequeno vem também em errors, apontando para fields.N.width do campo em questão.