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

Contracten erin, ondertekend eruit.

Bona Fide is e-handtekeningen als API. Maak van een sjabloon en uw data een envelop die klaar is om te ondertekenen, laat mensen ondertekenen in uw product of op een gehoste pagina en ontvang een verzegelde pdf die iedereen kan verifiëren.

Snelstart API-naslag

Hoe alles samenhangt

Sjablonen

Upload een pdf (of een Word-bestand) en plaats velden, of schrijf het contract in Documentmodus. Variabelen zijn een JSON Schema, zodat de API uw data valideert voordat er iets wordt verstuurd. Gepubliceerde versies zijn onveranderlijk.

Enveloppen

Eén POST /v1/envelopes rendert een sjabloon met uw variabelen en begint de routering naar ontvangers op rol en volgorde. Proefruns, idempotency keys en ontdubbeling op externalId zijn ingebouwd.

Ondertekenen op uw manier

Links per e-mail, een gehoste pagina of de webcomponent <bf-signing> (met wrappers voor React en Vue) in uw eigen app, met kortlevende sessies voor eenmalig gebruik die uw backend aanmaakt.

Bewijs dat iedereen kan controleren

Elk voltooid document krijgt een PAdES-documenttijdstempel van een openbare tijdstempelautoriteit, en de vingerafdruk ervan komt in een Merkle-boom waarvan Bona Fide de roots met Ed25519 ondertekent. Iedereen kan een exemplaar verifiëren, zonder account.

De levenscyclus in één oogopslag

Ontwerp een sjabloon in het dashboard of via de API en publiceer daarna een versie.
Verstuur een envelop: POST /v1/envelopes met het sjabloon-id, uw variabelen en één ontvanger per rol.
Onderteken: ontvangers krijgen een link per e-mail, of u maakt een ondertekeningssessie aan en sluit die in (delivery: "embedded").
Voltooi: wanneer de laatste ontvanger ondertekent, krijgt u een envelope.completed-webhook met alle ingevulde waarden.
Verzegel: de verzegelde pdf (met het voltooiingscertificaat) is klaar wanneer envelope.sealed binnenkomt.
Verifieer: iedereen kan de pdf op de verificatiepagina neerzetten of de openbare verificatie-API aanroepen.

Waarom de API prettig werkt

Fouten waar u iets mee kunt. Elke fout is RFC 9457 problem+json; validatiefouten bevatten per probleem een JSON Pointer, zoals /variables/client/email.
Veilig opnieuw proberen. Stuur een Idempotency-Key mee bij POST-requests, dan krijgt een nieuwe poging opnieuw het eerste antwoord.
Gratis, onbeperkte testmodus. Met bf_test_-keys maakt u enveloppen met een watermerk die nooit worden gefactureerd. Zie Authenticatie.
Webhooks die een standaard volgen. Leveringen worden ondertekend volgens Standard Webhooks, drie dagen lang opnieuw geprobeerd en kunnen opnieuw worden afgespeeld.
OpenAPI 3.1, gegenereerd uit de code. De naslag en de downloadbare openapi.json / openapi.yaml worden gebouwd uit dezelfde zod-contracten waarmee de API valideert.

Volgende stappen

SnelstartAPI-key, envelop uit een sjabloon, ondertekening en de voltooiingswebhook in tien minuten.

ConceptenSjablonen, rollen, velden, enveloppen, ontvangers, sessies en organisaties.

Ingesloten ondertekeningBreng het ondertekenen naar uw eigen product met .

VerificatieHoe verzegelen en verankeren werken, en hoe u zelf een document controleert.

De API staat op https://api.bonafidesign.com. Alle paden in deze documentatie zijn relatief ten opzichte daarvan.