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

Avtal in, signerade ut.

Bona Fide är e-signering som ett API. Gör om en mall och dina data till ett kuvert som är redo att signeras, låt folk signera i din produkt eller på en hostad sida och få tillbaka en förseglad PDF som vem som helst kan verifiera.

Snabbstart API-referens

Så hänger det ihop

Mallar

Ladda upp en PDF (eller en Word-fil) och placera fält, eller skriv avtalet i dokumentläge. Variablerna är ett JSON Schema, så API:et validerar dina data innan något skickas. Versioner kan inte ändras när de väl har publicerats.

Kuvert

Ett enda POST /v1/envelopes renderar en mall med dina variabler och börjar dirigera den till mottagarna efter roll och ordning. Testkörningar, idempotensnycklar och deduplicering via externalId är inbyggda.

Signering på ditt sätt

Länkar via e-post, en hostad sida eller webbkomponenten <bf-signing> (med omslag för React och Vue) i din egen app, med kortlivade sessioner för engångsbruk som skapas av din backend.

Bevis som vem som helst kan kontrollera

Varje slutfört dokument får en PAdES-dokumenttidsstämpel från en offentlig tidsstämpelutfärdare, och dess fingeravtryck läggs in i ett Merkle-träd vars rötter Bona Fide signerar med Ed25519. Vem som helst kan verifiera en kopia, utan konto.

Livscykeln i en bild

Utforma en mall i instrumentpanelen eller via API:et och publicera sedan en version.
Skicka ett kuvert: POST /v1/envelopes med mallens id, dina variabler och en mottagare per roll.
Signera: mottagarna får en länk via e-post, eller så skapar du en signeringssession och bäddar in den (delivery: "embedded").
Slutför: när den sista mottagaren har signerat får du en webhook av typen envelope.completed med alla ifyllda värden.
Försegla: den förseglade PDF:en (med slutförandecertifikatet) är klar när envelope.sealed kommer.
Verifiera: vem som helst kan släppa PDF:en på verifieringssidan eller anropa det offentliga verifierings-API:et.

Därför är API:et trevligt att arbeta med

Fel som går att åtgärda. Varje fel är RFC 9457 problem+json; valideringsfel innehåller en JSON Pointer per problem, till exempel /variables/client/email.
Säkra omförsök. Skicka en Idempotency-Key med POST-anrop, så spelas det första svaret upp igen vid ett omförsök.
Gratis, obegränsat testläge. bf_test_-nycklar skapar vattenmärkta kuvert som aldrig debiteras. Se Autentisering.
Webhooks som följer en standard. Leveranserna signeras enligt Standard Webhooks, görs om i tre dagar och kan spelas upp igen.
OpenAPI 3.1, genererat från koden. Referensen och de nedladdningsbara openapi.json / openapi.yaml byggs från samma zod-kontrakt som API:et validerar med.

Nästa steg

SnabbstartAPI-nyckel, kuvert från en mall, signering och webhooken för slutförande på tio minuter.

BegreppMallar, roller, fält, kuvert, mottagare, sessioner och organisationer.

Inbäddad signeringLägg signeringsupplevelsen i din produkt med .

VerifieringHur försegling och förankring fungerar, och hur du själv kontrollerar ett dokument.

API:et finns på https://api.bonafidesign.com. Alla sökvägar i den här dokumentationen är relativa till den adressen.