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

Le contrat entre, il ressort signé.

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

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

Comment tout s’articule

Modèles

Téléversez un PDF (ou un fichier Word) et placez-y des champs, ou rédigez le contrat en mode Document. Les variables sont décrites par un JSON Schema : l’API valide donc vos données avant tout envoi. Une fois publiées, les versions ne peuvent plus être modifiées.

Enveloppes

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

La signature, à votre façon

Liens par courriel, page hébergée ou composant Web <bf-signing> (avec des adaptateurs React et Vue) dans votre propre application, avec des sessions éphémères à usage unique créées par votre back-end.

Des preuves vérifiables par tous

Chaque document finalisé reçoit un horodatage de document PAdES d’une autorité d’horodatage publique, et son empreinte est ajoutée à un arbre de Merkle dont Bona Fide signe les racines en Ed25519. N’importe qui peut vérifier une copie, sans avoir besoin de compte.

Le cycle de vie en un coup d’œil

Concevoir un modèle dans le tableau de bord ou au moyen de l’API, puis en publier une version.
Envoyer une enveloppe : POST /v1/envelopes avec l’identifiant du modèle, vos variables et un destinataire par rôle.
Signer : les destinataires reçoivent un lien par courriel, 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 avec toutes les valeurs saisies.
Sceller : le PDF scellé (avec son certificat de finalisation) est prêt à l’arrivée de envelope.sealed.
Vérifier : n’importe qui peut déposer le PDF sur la page de vérification ou appeler l’API de vérification publique.

Ce qui rend l’API agréable

Des erreurs sur lesquelles agir. Chaque erreur est au format problem+json de la RFC 9457; les erreurs de validation fournissent un JSON Pointer par problème, par exemple /variables/client/email.
Des nouvelles tentatives sans risque. Envoyez une Idempotency-Key avec vos 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 avec filigrane qui ne sont jamais facturées. Consultez Authentification.
Des webhooks conformes à une norme. 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 avec lesquels l’API valide les requêtes.

Prochaines étapes

Démarrage rapideClé d’API, enveloppe à 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 se trouve à l’adresse https://api.bonafidesign.com. Tous les chemins de cette documentation sont relatifs à cette adresse.