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 ind, underskrevet ud.

Bona Fide er e-signatur som et API. Gør en skabelon og dine data til en kuvert, der er klar til underskrift, lad folk underskrive i dit produkt eller på en hostet side, og modtag en forseglet PDF, som alle kan verificere.

Kom hurtigt i gang API-reference

Sådan hænger det sammen

Skabeloner

Upload en PDF (eller en Word-fil) og placer felter, eller skriv kontrakten i dokumenttilstand. Variablerne er et JSON Schema, så API’et validerer dine data, før noget sendes. Versioner kan ikke ændres, når de først er udgivet.

Kuverter

Ét POST /v1/envelopes renderer en skabelon med dine variabler og begynder at sende den videre til modtagerne efter rolle og rækkefølge. Prøvekørsler, idempotensnøgler og deduplikering via externalId er indbygget.

Underskrift på din måde

Links pr. e-mail, en hostet side eller webkomponenten <bf-signing> (med wrappers til React og Vue) i din egen app, med kortlivede sessioner til engangsbrug, som din backend opretter.

Beviser, som alle kan tjekke

Hvert fuldført dokument får et PAdES-dokumenttidsstempel fra en offentlig tidsstempelmyndighed, og dets fingeraftryk indgår i et Merkle-træ, hvis rødder Bona Fide signerer med Ed25519. Alle kan verificere en kopi, uden at skulle have en konto.

Livscyklussen i ét billede

Design en skabelon i dashboardet eller via API’et, og udgiv derefter en version.
Send en kuvert: POST /v1/envelopes med skabelonens id, dine variabler og én modtager pr. rolle.
Underskriv: modtagerne får et link pr. e-mail, eller du opretter en signeringssession og indlejrer den (delivery: "embedded").
Fuldfør: når den sidste modtager har underskrevet, får du et envelope.completed-webhook med alle udfyldte værdier.
Forsegl: den forseglede PDF (med fuldførelsescertifikatet) er klar, når envelope.sealed ankommer.
Verificér: alle kan slippe PDF’en på verificeringssiden eller kalde det offentlige verificerings-API.

Derfor er API’et rart at arbejde med

Fejl, du kan handle på. Alle fejl er RFC 9457 problem+json; valideringsfejl indeholder en JSON Pointer pr. problem, f.eks. /variables/client/email.
Sikre genforsøg. Send en Idempotency-Key med POST-kald, så afspilles det første svar igen ved et genforsøg.
Gratis, ubegrænset testtilstand. bf_test_-nøgler opretter kuverter med vandmærke, som aldrig faktureres. Se Godkendelse.
Webhooks, der følger en standard. Leveringer signeres efter Standard Webhooks, forsøges igen i tre dage og kan afspilles igen.
OpenAPI 3.1, genereret fra koden. Referencen og de downloadbare openapi.json / openapi.yaml bygges fra de samme zod-kontrakter, som API’et validerer med.

Næste trin

Kom hurtigt i gangAPI-nøgle, kuvert fra en skabelon, underskrift og webhooket ved fuldførelse på ti minutter.

BegreberSkabeloner, roller, felter, kuverter, modtagere, sessioner og organisationer.

Indlejret underskriftPlacer underskriftsoplevelsen i dit produkt med .

VerificeringSådan fungerer forsegling og forankring, og sådan tjekker du selv et dokument.

API’et findes på https://api.bonafidesign.com. Alle stier i denne dokumentation er relative til den adresse.