AssinAPI

Kit pronto

Para quem quer só as chaves e o código. Em 3 passos o seu sistema envia documentos, acompanha o status, baixa o PDF assinado e recebe avisos.

Os 3 passos

  1. Chaves: no dashboard, em Integração → Kit pronto, clique em Gerar chave. Se o seu sistema tiver uma URL pública, informe-a para receber avisos automáticos (webhook). O kit monta o .env para você copiar.
  2. Código: escolha a plataforma — Node.js/Next.js, Supabase/Lovable, PHP, Python ou n8n/Make — e copie (ou baixe) um único arquivo.
  3. Teste no Sandbox: código de confirmação 123456, CPFs de teste 529.982.247-25 e 111.444.777-35. Depois troque só o .env pelas chaves de Produção.

O que o arquivo faz

  • enviarParaAssinatura — PDF + signatários (com posições e foto/selfie opcionais). Devolve o id (sigreq_…) e o link de cada pessoa.
  • consultarAssinatura — completed (pronto?) e nextStep (“Aguardando assinatura de Maria.”). Use se não tiver webhook.
  • baixarPdfAssinado — o PDF final com a página de auditoria (ou o certificado).
  • reenviarLembrete, cancelarAssinatura, aprovarIdentidade, reprovarIdentidade.
  • receberWebhook + tratarEvento — valida a assinatura HMAC e mostra onde atualizar o status no seu banco (pendente → finalizado).

Como o status chega ao seu sistema

Guarde o id retornado (ou envie seu próprio externalId). Depois, escolha: webhook (a AssinAPI avisa na hora — recomendado) ou consulta periódica (o seu sistema pergunta a cada X minutos). Os dois caminhos já estão no arquivo.

AvisoSignificaO que fazer
signer.signedUma pessoa assinouStatus parcial
envelope.completedTodos assinaram e o PDF está prontoMarcar FINALIZADO e baixar o PDF
signer.identity_submittedFotos aguardando sua aprovaçãoAprovar ou reprovar
signer.declined / envelope.expired / envelope.cancelledEncerrado sem assinaturaMarcar como recusado/expirado/cancelado