契約書を入れれば、署名済みで返ってくる。

全体の構成

テンプレート

PDF（または Word ファイル）をアップロードしてフィールドを配置するか、ドキュメントモードで契約書を作成します。変数は JSON Schema で定義されるため、送信前に API がデータを検証します。公開したバージョンは変更できません。

エンベロープ

POST /v1/envelopes を 1 回呼び出すだけで、変数を使ってテンプレートをレンダリングし、ロールと順序に従って受信者への回付を開始します。 ドライラン、べき等キー、externalId による重複排除が標準で備わっています。

署名の方法は自由に

メールのリンク、ホスト型ページ、または自社アプリ内の <bf-signing> Web コンポーネント（React と Vue のラッパーあり）。 セッションはバックエンドで発行する、短時間有効で 1 回限りのものです。

誰でも確認できる証拠

完了したドキュメントにはすべて、公開タイムスタンプ局による PAdES ドキュメントタイムスタンプが付与されます。そのフィンガープリントは Merkle ツリーに追加され、そのルートに Bona Fide が Ed25519 で署名します。アカウントがなくても、誰でもコピーを検証できます。

ライフサイクルの全体像

1. 設計：ダッシュボードまたは API でテンプレートを設計し、バージョンを公開します。
2. 送信：テンプレート ID、変数、ロールごとに 1 人の受信者を指定して、POST /v1/envelopes でエンベロープを送信します。
3. 署名：受信者はメールでリンクを受け取ります。または、署名セッションを発行して埋め込みます（delivery: "embedded"）。
4. 完了：最後の受信者が署名すると、入力されたすべての値を含む envelope.completed Webhook が届きます。
5. 封印：envelope.sealed が届いた時点で、封印済み PDF（完了証明書付き）の準備が整っています。
6. 検証：誰でも PDF を検証ページにドロップするか、公開検証 API を呼び出して検証できます。

使いやすい API の理由

• 対処できるエラー。 すべてのエラーは RFC 9457 problem+json 形式です。検証エラーには、問題ごとに /variables/client/email のような JSON Pointer が含まれます。
• 安全なリトライ。 POST リクエストに Idempotency-Key を付けて送信すれば、リトライ時には最初のレスポンスが再送されます。
• 無料・無制限のテストモード。 bf_test_ キーで作成したエンベロープには透かしが入り、課金されることはありません。認証を参照してください。
• 標準に準拠した Webhook。 配信は Standard Webhooks に従って署名され、3 日間リトライされ、再送することもできます。
• コードから生成される OpenAPI 3.1。 リファレンスと、ダウンロード可能な openapi.json / openapi.yaml は、API が検証に使うものと同じ zod コントラクトからビルドされています。

次のステップ

クイックスタートAPI キーの作成、テンプレートからのエンベロープ作成、署名、完了 Webhook の受信までを 10 分で。

コンセプトテンプレート、ロール、フィールド、エンベロープ、受信者、セッション、組織。

埋め込み署名 で署名体験を自社製品に組み込みます。

検証封印とアンカリングの仕組みと、ドキュメントを自分で確認する方法。

API のベース URL は https://api.bonafidesign.com です。このドキュメントに記載されているパスはすべて、この URL からの相対パスです。