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

Des contrats en entrée, signés en sortie.

Bona Fide, c’est la signature électronique sous forme d’API. Transformez un modèle et vos données en une enveloppe prête à signer, faites signer vos interlocuteurs dans votre produit ou sur une page hébergée et recevez un PDF scellé que chacun peut vérifier.

Démarrage rapide Référence de l’API

Comment tout s’articule

Modèles

Importez un PDF (ou un fichier Word) et placez-y des champs, ou rédigez le contrat en mode Document. Les variables forment un JSON Schema : l’API valide donc vos données avant tout envoi. Une fois publiées, les versions sont immuables.

Enveloppes

Un seul POST /v1/envelopes génère le document à partir d’un modèle et de vos variables, puis l’achemine vers les destinataires selon leur rôle et leur ordre. Simulations, clés d’idempotence et dédoublonnage par externalId sont intégrés d’office.

La signature, à votre façon

Des liens par e-mail, une page hébergée ou le web component <bf-signing> (avec des wrappers React et Vue) dans votre propre application, avec des sessions éphémères à usage unique créées par votre backend.

Des preuves vérifiables par tous

Chaque document finalisé reçoit un horodatage de document PAdES émis par une autorité d’horodatage publique, et son empreinte entre dans un arbre de Merkle dont Bona Fide signe les racines en Ed25519. Chacun peut vérifier une copie, sans compte.

Le cycle de vie en un coup d’œil

Concevoir : créez un modèle dans le tableau de bord ou via l’API, puis publiez une version.
Envoyer : créez une enveloppe avec POST /v1/envelopes, l’identifiant du modèle, vos variables et un destinataire par rôle.
Signer : les destinataires reçoivent un lien par e-mail, ou vous créez une session de signature et l’intégrez (delivery: "embedded").
Finaliser : quand le dernier destinataire a signé, vous recevez un webhook envelope.completed contenant toutes les valeurs saisies.
Sceller : le PDF scellé (avec son certificat de finalisation) est prêt à l’arrivée de envelope.sealed.
Vérifier : chacun peut déposer le PDF sur la page de vérification ou appeler l’API publique de vérification.

Ce qui rend l’API agréable

Des erreurs exploitables. Chaque erreur est au format RFC 9457 problem+json ; les erreurs de validation comportent un JSON Pointer par problème, par exemple /variables/client/email.
Des nouvelles tentatives sans risque. Envoyez un Idempotency-Key avec vos requêtes POST : une nouvelle tentative renvoie la première réponse.
Un mode test gratuit et illimité. Les clés bf_test_ créent des enveloppes filigranées qui ne sont jamais facturées. Consultez Authentification.
Des webhooks conformes à un standard. Les livraisons sont signées selon Standard Webhooks, relancées pendant trois jours et peuvent être rejouées.
OpenAPI 3.1, généré à partir du code. La référence et les fichiers téléchargeables openapi.json / openapi.yaml sont produits à partir des mêmes contrats zod que ceux utilisés par l’API pour la validation.

Étapes suivantes

Démarrage rapideClé API, enveloppe créée à partir d’un modèle, signature et webhook de finalisation en dix minutes.

ConceptsModèles, rôles, champs, enveloppes, destinataires, sessions et organisations.

Signature intégréeIntégrez l’expérience de signature à votre produit avec .

VérificationLe fonctionnement du scellement et de l’ancrage, et comment vérifier un document vous-même.

L’API est disponible à l’adresse https://api.bonafidesign.com. Tous les chemins de cette documentation sont relatifs à celle-ci.