メインコンテンツへスキップ
企業エンティティの管理はすべて、/v3/businesses/配下にある6つの公開エンドポイントを通じて行います。このページでは概念的な概要を説明します。リクエストとレスポンスの完全なスキーマについてはAPIリファレンスを参照してください。

企業の一覧取得

GET /v3/businesses/ アプリケーションに属する企業をページネーション付きの一覧で取得します。ステータス、検索語、国、日付範囲でフィルターできます。

企業の取得

GET /v3/businesses/{vendor_data}/ vendor_dataを指定して1件の企業を取得します。

企業の作成

POST /v3/businesses/create/ 法人確認 (KYB)セッションを実行する前に、企業を事前に作成します:
同じvendor_dataの企業がすでに存在する場合は、競合エラーを返します。既存の企業を更新するにはPATCHを使用してください。

企業の更新

PATCH /v3/businesses/{vendor_data}/ 変更可能なプロフィールフィールドを更新します。法人登記の照会から得られたフィールド(legal_name、registration_number、country_code)は検証後は読み取り専用ですが、上書きは可能です。上書きした内容は監査ログでフラグ付けされます。 変更可能なフィールド:display_name、metadata、tags。 検証後に読み取り専用となるもの:法人登記から得られたすべてのフィールド、集計カウンター、featuresマップ。
business.data.updatedを発行します。

ステータスの変更

PATCH /v3/businesses/{vendor_data}/update-status/ 企業のステータスをACTIVE、FLAGGED、BLOCKEDの間で変更します。
business.status.updatedを発行します。

企業の削除 (一括)

POST /v3/businesses/delete/ 1件以上の企業を削除します。企業レコードは完全に削除されます。このエンドポイントは検証セッションを対象としないため、セッションは企業との紐付けが解除された状態で残ります。セッションはDelete Sessionで削除してください。取引も対象外です。取引はConsoleから削除してください。
冪等です。すでに削除された企業を削除しても何も起こりません。

権限モデル

/v3/businesses/*のすべてのエンドポイントへのアクセスは、businesses権限リソースによって制御されます: 役割と権限を参照してください。

これらの操作で送信されるWebhook

次のステップ

データモデル

全フィールドのリファレンス。

一覧取得API

GET /v3/businesses/のスキーマ。

作成API

POST /v3/businesses/create/のスキーマ。
最終更新日 2026年11月1日