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

Kontrakter inn, signert ut.

Bona Fide er e-signering som et API. Gjør en mal og dataene dine om til en konvolutt klar for signering, la folk signere i produktet ditt eller på en side vi hoster, og motta en forseglet PDF som alle kan verifisere.

Hurtigstart API-referanse

Slik henger det sammen

Maler

Last opp en PDF (eller en Word-fil) og plasser felt, eller skriv kontrakten i dokumentmodus. Variablene er et JSON Schema, så API-et validerer dataene dine før noe sendes. Versjoner kan ikke endres etter at de er publisert.

Konvolutter

Ett POST /v1/envelopes rendrer en mal med variablene dine og begynner å rute til mottakerne etter rolle og rekkefølge. Testkjøringer, idempotensnøkler og deduplisering på externalId er innebygd.

Signering på din måte

Lenker på e-post, en side vi hoster, eller webkomponenten <bf-signing> (med innpakninger for React og Vue) i din egen app, med kortlivede engangsøkter som backenden din oppretter.

Bevis alle kan kontrollere

Hvert fullført dokument får et PAdES-dokumenttidsstempel fra en offentlig tidsstempeltjeneste, og fingeravtrykket legges inn i et Merkle-tre der Bona Fide signerer røttene med Ed25519. Alle kan verifisere en kopi, uten konto.

Livsløpet i ett bilde

Design en mal i dashbordet eller via API-et, og publiser deretter en versjon.
Send en konvolutt: POST /v1/envelopes med mal-ID-en, variablene dine og én mottaker per rolle.
Signer: mottakerne får en lenke på e-post, eller du oppretter en signeringsøkt og bygger den inn (delivery: "embedded").
Fullfør: når den siste mottakeren signerer, får du en envelope.completed-webhook med alle utfylte verdier.
Forsegl: den forseglede PDF-en (med fullføringssertifikatet) er klar når envelope.sealed kommer.
Verifiser: alle kan slippe PDF-en på verifiseringssiden eller kalle det offentlige verifiserings-API-et.

Det som gjør API-et behagelig å bruke

Feil du kan handle ut fra. Alle feil er RFC 9457 problem+json; valideringsfeil har en JSON Pointer per problem, for eksempel /variables/client/email.
Trygge nye forsøk. Send en Idempotency-Key med POST-forespørsler, så spilles det første svaret av på nytt ved et nytt forsøk.
Gratis, ubegrenset testmodus. bf_test_-nøkler oppretter konvolutter med vannmerke som aldri faktureres. Se Autentisering.
Webhooks som følger en standard. Leveringer signeres etter Standard Webhooks, prøves på nytt i tre dager og kan spilles av igjen.
OpenAPI 3.1, generert fra koden. Referansen og de nedlastbare filene openapi.json / openapi.yaml bygges fra de samme zod-kontraktene som API-et validerer med.

Neste steg

HurtigstartAPI-nøkkel, konvolutt fra en mal, signering og fullføringswebhooken på ti minutter.

KonsepterMaler, roller, felt, konvolutter, mottakere, økter og organisasjoner.

Innebygd signeringLegg signeringsopplevelsen inn i produktet ditt med .

VerifiseringSlik fungerer forsegling og forankring, og slik kontrollerer du et dokument selv.

API-et ligger på https://api.bonafidesign.com. Alle stier i denne dokumentasjonen er relative til denne adressen.