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 é a assinatura eletrónica como API. Transforme um modelo e os seus dados num envelope pronto a assinar, deixe as pessoas assinarem dentro do seu produto ou numa página alojada e receba um PDF selado que qualquer pessoa pode verificar.

Início rápido Referência da API

Como tudo se articula

Modelos

Carregue um PDF (ou um ficheiro do Word) e coloque os campos, ou redija o contrato no modo Documento. As variáveis são um JSON Schema, pelo que a API valida os seus dados antes de qualquer envio. As versões são imutáveis depois de publicadas.

Envelopes

Um único POST /v1/envelopes gera um modelo com as suas variáveis e começa a encaminhá-lo para os destinatários por função e ordem. Simulações, chaves de idempotência e eliminação de duplicados por externalId vêm de origem.

Assinatura à sua maneira

Ligações por e-mail, uma página alojada ou o web component <bf-signing> (com wrappers para React e Vue) dentro da sua própria aplicação, com sessões de utilização única e curta duração criadas pelo seu backend.

Provas que qualquer pessoa pode verificar

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

O ciclo de vida numa imagem

Conceba um modelo no painel ou através da API e publique uma versão.
Envie um envelope: POST /v1/envelopes com o id do modelo, as suas variáveis e um destinatário por função.
Assine: os destinatários recebem uma ligação por e-mail, ou cria uma sessão de assinatura e integra-a (delivery: "embedded").
Conclua: quando o último destinatário assina, recebe um webhook envelope.completed com todos os valores introduzidos.
Sele: o PDF selado (com o respetivo certificado de conclusão) fica pronto quando chega o envelope.sealed.
Verifique: qualquer pessoa pode largar 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 que pode agir. Todos os erros seguem o problem+json da RFC 9457; os erros de validação incluem um JSON Pointer por problema, como /variables/client/email.
Repetições seguras. Envie um Idempotency-Key nos POST e uma repetição devolve novamente a primeira resposta.
Modo de teste gratuito e ilimitado. As chaves bf_test_ criam envelopes com marca de água que nunca são faturados. Consulte Autenticação.
Webhooks que seguem uma norma. As entregas são assinadas segundo o Standard Webhooks, repetidas durante três dias e podem ser reenviadas.
OpenAPI 3.1, gerado a partir do código. A referência e os ficheiros openapi.json / openapi.yaml para transferência são gerados a partir dos mesmos contratos zod com que a API valida os pedidos.

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, funções, campos, envelopes, destinatários, sessões e organizações.

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

VerificaçãoComo funcionam a selagem e a ancoragem, e como verificar um documento por si próprio.

A API está disponível em https://api.bonafidesign.com. Todos os caminhos desta documentação são relativos a esse endereço.