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

अनुबंध अंदर, हस्ताक्षरित बाहर।

Bona Fide, API के रूप में ई-हस्ताक्षर है। टेम्पलेट और अपने डेटा से हस्ताक्षर के लिए तैयार लिफ़ाफ़ा बनाएँ, लोगों को अपने प्रोडक्ट के अंदर या होस्ट किए गए पेज पर हस्ताक्षर करने दें, और ऐसा सील किया गया PDF पाएँ जिसे कोई भी सत्यापित कर सके।

क्विकस्टार्ट API रेफ़रेंस

सब कुछ एक साथ कैसे जुड़ता है

टेम्पलेट

PDF (या Word फ़ाइल) अपलोड करें और फ़ील्ड लगाएँ, या अनुबंध को Document मोड में लिखें। वेरिएबल एक JSON Schema होते हैं, इसलिए कुछ भी भेजे जाने से पहले API आपके डेटा की जाँच करता है। पब्लिश होने के बाद वर्ज़न बदले नहीं जा सकते।

लिफ़ाफ़े

एक POST /v1/envelopes आपके वेरिएबल के साथ टेम्पलेट को रेंडर करता है और प्राप्तकर्ताओं को भूमिका और क्रम के अनुसार भेजना शुरू कर देता है। ड्राई रन, आइडेम्पोटेंसी कुंजियाँ और externalId से डुप्लिकेट रोकना पहले से शामिल हैं।

हस्ताक्षर, आपके तरीके से

ईमेल लिंक, होस्ट किया गया पेज, या आपके अपने ऐप के अंदर <bf-signing> वेब कंपोनेंट (React और Vue रैपर के साथ), जिसके कम अवधि वाले, एक बार इस्तेमाल होने वाले सेशन आपका बैकएंड बनाता है।

ऐसा साक्ष्य, जिसे कोई भी जाँच सके

हर पूरे हुए दस्तावेज़ को किसी सार्वजनिक टाइमस्टैम्प अथॉरिटी से PAdES दस्तावेज़ टाइमस्टैम्प मिलता है, और उसका फ़िंगरप्रिंट एक Merkle ट्री में जाता है, जिसके रूट पर Bona Fide, Ed25519 से हस्ताक्षर करता है। कोई भी किसी प्रति को सत्यापित कर सकता है, अकाउंट की ज़रूरत नहीं।

पूरा जीवनचक्र, एक नज़र में

डिज़ाइन करें: डैशबोर्ड में या API से टेम्पलेट बनाएँ, फिर एक वर्ज़न पब्लिश करें।
भेजें: एक लिफ़ाफ़ा भेजें: टेम्पलेट id, अपने वेरिएबल और हर भूमिका के लिए एक प्राप्तकर्ता के साथ POST /v1/envelopes।
हस्ताक्षर: प्राप्तकर्ताओं को ईमेल लिंक मिलता है, या आप एक हस्ताक्षर सेशन बनाकर उसे एम्बेड करते हैं (delivery: "embedded")।
पूरा होना: जब आख़िरी प्राप्तकर्ता हस्ताक्षर कर देता है, तो आपको हर टाइप किए गए मान के साथ envelope.completed वेबहुक मिलता है।
सील: envelope.sealed आने पर सील किया गया PDF (पूर्णता प्रमाणपत्र के साथ) तैयार होता है।
सत्यापन: कोई भी PDF को सत्यापन पेज पर छोड़ सकता है या सार्वजनिक सत्यापन API को कॉल कर सकता है।

API के साथ काम करना आसान क्यों है

ऐसे एरर, जिन पर आप कार्रवाई कर सकें। हर एरर RFC 9457 problem+json होता है; वैलिडेशन एरर में हर समस्या के लिए एक JSON Pointer होता है, जैसे /variables/client/email।
सुरक्षित रीट्राई। POST अनुरोधों पर Idempotency-Key भेजें, तो रीट्राई पर पहला रिस्पॉन्स ही दोबारा मिलता है।
मुफ़्त, असीमित टेस्ट मोड। bf_test_ कुंजियाँ वॉटरमार्क वाले लिफ़ाफ़े बनाती हैं, जिनका कभी बिल नहीं बनता। ऑथेंटिकेशन देखें।
मानक का पालन करने वाले वेबहुक। डिलीवरी Standard Webhooks के अनुसार हस्ताक्षरित होती हैं, तीन दिन तक रीट्राई की जाती हैं, और दोबारा भेजी जा सकती हैं।
OpenAPI 3.1, सीधे कोड से जनरेट। रेफ़रेंस और डाउनलोड किए जा सकने वाले openapi.json / openapi.yaml उन्हीं zod कॉन्ट्रैक्ट से बनते हैं, जिनसे API वैलिडेशन करता है।

आगे क्या करें

क्विकस्टार्टदस मिनट में API कुंजी, टेम्पलेट से लिफ़ाफ़ा, हस्ताक्षर और पूर्णता वेबहुक।

अवधारणाएँटेम्पलेट, भूमिकाएँ, फ़ील्ड, लिफ़ाफ़े, प्राप्तकर्ता, सेशन और संगठन।

एम्बेडेड हस्ताक्षर

के साथ हस्ताक्षर का अनुभव अपने प्रोडक्ट के अंदर लाएँ।

सत्यापनसीलिंग और एंकरिंग कैसे काम करती हैं, और किसी दस्तावेज़ की जाँच ख़ुद कैसे करें।

API https://api.bonafidesign.com पर उपलब्ध है। इन डॉक्स के सभी पाथ इसी के सापेक्ष हैं।