POST /v1/envelopes

{
  "template": "tpl_mutual_nda",
  "variables": {
    "client": { "name": "Acme Robotics" }
  },
  "recipients": [
    { "role": "client", "name": "Jane Doe",
      "email": "jane@acme.dev" }
  ],
  "delivery": "embedded"
}

201 env_8Gm2kQ4rT1 · sent → completed · sealed

Entra o contrato, sai assinado.

A Bona Fide é assinatura eletrônica como API. Transforme um modelo e seus dados em um envelope pronto para assinar, deixe as pessoas assinarem dentro do seu produto ou em uma página hospedada e receba um PDF selado que qualquer pessoa pode verificar.

Início rápido Referência da API

Como tudo se encaixa

Modelos

Envie um PDF (ou um arquivo do Word) e posicione os campos, ou escreva o contrato no modo Documento. As variáveis são um JSON Schema, então a API valida seus dados antes de qualquer envio. As versões são imutáveis depois de publicadas.

Envelopes

Um único POST /v1/envelopes renderiza um modelo com suas variáveis e inicia o roteamento para os destinatários por papel e ordem. Simulações, chaves de idempotência e deduplicação por externalId já vêm prontas.

Assinatura do seu jeito

Links por e-mail, uma página hospedada ou o web component <bf-signing> (com wrappers para React e Vue) dentro do seu próprio app, com sessões de uso único e curta duração geradas pelo seu backend.

Evidências que qualquer pessoa pode conferir

Todo documento concluído recebe um carimbo de tempo de documento PAdES de uma autoridade de carimbo de tempo pública, e a impressão digital dele entra em uma árvore de Merkle cujas raízes a Bona Fide assina com Ed25519. Qualquer pessoa pode verificar uma cópia, sem precisar de conta.

O ciclo de vida em uma imagem

Crie um modelo no painel ou pela API e publique uma versão.
Envie um envelope: POST /v1/envelopes com o id do modelo, suas variáveis e um destinatário por papel.
Assine: os destinatários recebem um link por e-mail, ou você gera uma sessão de assinatura e a incorpora (delivery: "embedded").
Conclua: quando o último destinatário assina, você recebe um webhook envelope.completed com todos os valores preenchidos.
Sele: o PDF selado (com o certificado de conclusão) fica pronto quando chega o envelope.sealed.
Verifique: qualquer pessoa pode soltar o PDF na página de verificação ou chamar a API pública de verificação.

O que torna a API agradável

Erros com os quais você pode agir. Todo erro é problem+json da RFC 9457; os erros de validação trazem um JSON Pointer por problema, como /variables/client/email.
Novas tentativas seguras. Envie um Idempotency-Key nos POSTs e uma nova tentativa reproduz a primeira resposta.
Modo de teste gratuito e ilimitado. As chaves bf_test_ criam envelopes com marca d’água que nunca são cobrados. Consulte Autenticação.
Webhooks que seguem um padrão. As entregas são assinadas conforme o Standard Webhooks, têm novas tentativas durante três dias e podem ser reenviadas.
OpenAPI 3.1, gerado a partir do código. A referência e os arquivos openapi.json / openapi.yaml para download são gerados a partir dos mesmos contratos zod com que a API valida as requisições.

Próximos passos

Início rápidoChave de API, envelope a partir de um modelo, assinatura e o webhook de conclusão em dez minutos.

ConceitosModelos, papéis, campos, envelopes, destinatários, sessões e organizações.

Assinatura incorporadaColoque a experiência de assinatura dentro do seu produto com .

VerificaçãoComo funcionam a selagem e a ancoragem, e como conferir um documento você mesmo.

A API fica em https://api.bonafidesign.com. Todos os caminhos desta documentação são relativos a esse endereço.