NexusSign — Assinatura eletrônica

Assinatura eletrônica em vários passos: enviar o PDF e os signatários, acompanhar quem assinou, baixar o documento assinado e, se precisar, cancelar. Os webhooks avisam a cada assinatura.

Envia um documento para assinatura

POST/v1/assinatura/documentos

Envia um PDF para uma ou mais pessoas assinarem. Cada pessoa recebe o

convite por e-mail e assina pelo link; a resposta traz o link de cada

uma, para quem prefere distribuir pelo próprio canal.

Cobrança. Um documento enviado é uma cobrança, não importa quantas

pessoas assinam. Pedido recusado ou que falhou não é cobrado. Cancelar

depois não devolve a cobrança.

Onde cada pessoa assina. Informe campos para escolher a página e a

posição (em porcentagem da página, a partir do canto de cima à

esquerda). Sem campos, as assinaturas vão em fila no fim da última

página.

O que quem assina informa. O CPF, obrigatório, e a localização, se

permitir. Os dois saem no certificado que acompanha o PDF assinado.

Chave de teste. Nada é enviado nem cobrado: o documento é assinado

na hora por todos. Quem tiver o e-mail começando por recusa recusa.

| Campo | Obrigatório | O que é |

|---|---|---|

| titulo | sim | Nome do documento, até 255 caracteres. |

| arquivo | sim | O PDF em base64, até 25 MB. |

| signatarios | sim | Uma ou mais pessoas, sem limite de quantidade, cada uma com nome e email. |

| signatarios[].telefone | não | Telefone da pessoa, com DDD. Fica só registrado: volta nas respostas e nos webhooks, e não é usado para enviar o convite. |

| signatarios[].campos | não | Onde a pessoa assina: pagina, x, y, largura, altura. |

| enviarEmail | não | false para não enviar o convite por e-mail. Padrão: true. |

| prazoDias | não | Dias para assinar, de 1 a 365. Padrão: 30. |

| mensagem | não | Texto que acompanha o convite, até 1000 caracteres. |

| referencia | não | Identificador seu, devolvido nas respostas e nos webhooks. |

Respostas

  • 201Documento enviado.
  • 400Corpo ilegível (urn:nexusquery:problema:dados-invalidos).
  • 401
  • 402Saldo insuficiente (urn:nexusquery:problema:saldo-insuficiente).
  • 413Arquivo acima de 25 MB (urn:nexusquery:problema:arquivo-grande-demais). Nada é cobrado.
  • 422Pedido fora das regras: o detalhe diz o que corrigir (urn:nexusquery:problema:documento-invalido ou arquivo-invalido). Nada é cobrado.
  • 429Muitos envios ao mesmo tempo (urn:nexusquery:problema:envios-em-andamento) ou limite da chave. Retry-After diz quando tentar. Nada é cobrado.
  • 502Assinatura indisponível (urn:nexusquery:problema:produto-indisponivel). Nada é cobrado.

Mostra o documento e quem já assinou

GET/v1/assinatura/documentos/{id}

Respostas

  • 200O documento.
  • 401
  • 404

Baixa o PDF assinado

GET/v1/assinatura/documentos/{id}/arquivo

Devolve o PDF com as assinaturas e o certificado no final: quem assinou, o CPF informado, data e hora, IP e a impressão digital (SHA-256) do arquivo original. Só documento concluído tem PDF assinado.

Respostas

  • 200O PDF assinado.
  • 401
  • 404
  • 409O documento ainda não foi concluído (urn:nexusquery:problema:documento-em-outro-estado).
  • 429Muitos arquivos em andamento ao mesmo tempo (urn:nexusquery:problema:envios-em-andamento). Retry-After diz quando tentar.
  • 502Assinatura indisponível (urn:nexusquery:problema:produto-indisponivel).

Cancela o documento pendente

POST/v1/assinatura/documentos/{id}/cancelar

Encerra o documento que ainda espera assinatura: os links param de funcionar. A cobrança do envio não é devolvida.

Respostas

  • 200O documento
  • 401
  • 404
  • 409O documento já foi encerrado (urn:nexusquery:problema:documento-em-outro-estado).
  • 502Assinatura indisponível (urn:nexusquery:problema:produto-indisponivel).