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

Verträge rein, unterschrieben raus.

Bona Fide ist E-Signatur als API. Machen Sie aus einer Vorlage und Ihren Daten einen unterschriftsreifen Umschlag, lassen Sie Personen direkt in Ihrem Produkt oder auf einer gehosteten Seite unterschreiben und erhalten Sie ein versiegeltes PDF, das jeder prüfen kann.

Schnellstart API-Referenz

So greift alles ineinander

Vorlagen

Laden Sie ein PDF (oder eine Word-Datei) hoch und platzieren Sie Felder, oder schreiben Sie den Vertrag im Dokumentmodus. Variablen sind ein JSON Schema, sodass die API Ihre Daten prüft, bevor etwas versendet wird. Veröffentlichte Versionen sind unveränderlich.

Umschläge

Ein einziges POST /v1/envelopes rendert eine Vorlage mit Ihren Variablen und leitet sie nach Rolle und Reihenfolge an die Empfänger weiter. Probeläufe, Idempotenzschlüssel und Deduplizierung über externalId sind bereits eingebaut.

Unterschreiben, wie Sie es wollen

Links per E-Mail, eine gehostete Seite oder die Web Component <bf-signing> (mit Wrappern für React und Vue) in Ihrer eigenen App, mit kurzlebigen Einmal-Sitzungen, die Ihr Backend erzeugt.

Nachweise, die jeder prüfen kann

Jedes abgeschlossene Dokument erhält einen PAdES-Dokumentzeitstempel einer öffentlichen Zeitstempelstelle, und sein Fingerabdruck fließt in einen Merkle-Baum, dessen Wurzeln Bona Fide mit Ed25519 signiert. Jeder kann eine Kopie prüfen, ganz ohne Konto.

Der Lebenszyklus auf einen Blick

Entwerfen: Gestalten Sie eine Vorlage im Dashboard oder über die API und veröffentlichen Sie eine Version.
Senden: Erstellen Sie einen Umschlag mit POST /v1/envelopes, der Vorlagen-ID, Ihren Variablen und einem Empfänger pro Rolle.
Unterschreiben: Empfänger erhalten einen Link per E-Mail, oder Sie erzeugen eine Signatursitzung und betten sie ein (delivery: "embedded").
Abschließen: Sobald der letzte Empfänger unterschrieben hat, erhalten Sie einen envelope.completed-Webhook mit allen eingegebenen Werten.
Versiegeln: Das versiegelte PDF (mit Abschlusszertifikat) liegt bereit, sobald envelope.sealed eintrifft.
Prüfen: Jeder kann das PDF auf der Prüfseite ablegen oder die öffentliche Verifizierungs-API aufrufen.

Was die API angenehm macht

Fehler, mit denen Sie etwas anfangen können. Jeder Fehler ist RFC 9457 problem+json; Validierungsfehler enthalten pro Problem einen JSON Pointer, etwa /variables/client/email.
Sichere Wiederholungen. Senden Sie bei POST-Anfragen einen Idempotency-Key mit, dann liefert eine Wiederholung die erste Antwort erneut.
Kostenloser, unbegrenzter Testmodus. bf_test_-Schlüssel erstellen Umschläge mit Wasserzeichen, die nie berechnet werden. Siehe Authentifizierung.
Webhooks nach Standard. Zustellungen werden nach Standard Webhooks signiert, drei Tage lang wiederholt und lassen sich erneut abspielen.
OpenAPI 3.1, aus dem Code generiert. Die Referenz und die herunterladbaren Dateien openapi.json / openapi.yaml entstehen aus denselben zod-Verträgen, mit denen die API validiert.

Nächste Schritte

SchnellstartAPI-Schlüssel, Umschlag aus einer Vorlage, Unterschrift und Abschluss-Webhook in zehn Minuten.

KonzepteVorlagen, Rollen, Felder, Umschläge, Empfänger, Sitzungen und Organisationen.

Eingebettete UnterschriftBringen Sie den Unterschriftsvorgang mit direkt in Ihr Produkt.

VerifizierungWie Versiegelung und Verankerung funktionieren und wie Sie ein Dokument selbst prüfen.

Die API ist unter https://api.bonafidesign.com erreichbar. Alle Pfade in dieser Dokumentation sind relativ dazu.