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

Kontrak masuk, ditandatangani keluar.

Bona Fide adalah tanda tangan elektronik dalam bentuk API. Ubah template dan data Anda menjadi amplop siap tanda tangan, biarkan orang menandatangani di dalam produk Anda atau di halaman yang di-hosting, lalu terima PDF yang disegel yang dapat diverifikasi siapa pun.

Mulai cepat Referensi API

Bagaimana semuanya saling terhubung

Template

Unggah PDF (atau file Word) lalu tempatkan kolom, atau tulis kontrak dalam mode Dokumen. Variabel berupa JSON Schema, sehingga API memvalidasi data Anda sebelum apa pun dikirim. Versi tidak dapat diubah setelah dipublikasikan.

Amplop

Satu POST /v1/envelopes merender template dengan variabel Anda dan mulai merutekan ke penerima berdasarkan peran dan urutan. Dry run, kunci idempotensi, dan deduplikasi externalId sudah tersedia bawaan.

Penandatanganan sesuai cara Anda

Tautan email, halaman yang di-hosting, atau web component <bf-signing> (dengan wrapper React dan Vue) di dalam aplikasi Anda sendiri, dengan sesi berumur pendek dan sekali pakai yang dibuat oleh backend Anda.

Bukti yang dapat diperiksa siapa pun

Setiap dokumen yang selesai mendapat stempel waktu dokumen PAdES dari otoritas stempel waktu publik, dan sidik jarinya dimasukkan ke pohon Merkle yang akarnya ditandatangani Bona Fide dengan Ed25519. Siapa pun dapat memverifikasi salinannya, tanpa perlu akun.

Siklus hidup dalam satu gambaran

Rancang template di dasbor atau melalui API, lalu publikasikan sebuah versi.
Kirim amplop: POST /v1/envelopes dengan id template, variabel Anda, dan satu penerima per peran.
Tandatangani: penerima mendapat tautan email, atau Anda membuat sesi penandatanganan dan menyematkannya (delivery: "embedded").
Selesaikan: saat penerima terakhir menandatangani, Anda menerima webhook envelope.completed berisi setiap nilai yang diisi.
Segel: PDF yang disegel (beserta sertifikat penyelesaiannya) siap saat envelope.sealed tiba.
Verifikasi: siapa pun dapat meletakkan PDF di halaman verifikasi atau memanggil API verifikasi publik.

Yang membuat API ini nyaman dipakai

Error yang bisa langsung ditindaklanjuti. Setiap error berformat RFC 9457 problem+json; error validasi menyertakan JSON Pointer per masalah, seperti /variables/client/email.
Percobaan ulang yang aman. Kirim Idempotency-Key pada POST, dan percobaan ulang akan memutar ulang respons pertama.
Mode uji gratis tanpa batas. Kunci bf_test_ membuat amplop bertanda air yang tidak pernah ditagih. Lihat Autentikasi.
Webhook yang mengikuti standar. Pengiriman ditandatangani sesuai Standard Webhooks, dicoba ulang selama tiga hari, dan dapat diputar ulang.
OpenAPI 3.1, dihasilkan dari kode. Referensi serta openapi.json / openapi.yaml yang dapat diunduh dibangun dari kontrak zod yang sama dengan yang dipakai API untuk validasi.

Langkah berikutnya

Mulai cepatKunci API, amplop dari template, penandatanganan, dan webhook penyelesaian dalam sepuluh menit.

KonsepTemplate, peran, kolom, amplop, penerima, sesi, dan organisasi.

Penandatanganan tersematTempatkan pengalaman penandatanganan di dalam produk Anda dengan .

VerifikasiCara kerja penyegelan dan anchoring, serta cara memeriksa dokumen sendiri.

API tersedia di https://api.bonafidesign.com. Semua path dalam dokumentasi ini relatif terhadap alamat tersebut.