メインコンテンツへスキップ
POST
curl

概要

法人確認 (KYB) セッションを実行する前に、法人エンティティを明示的に作成します。

使用するケース

  • 最初の法人確認 (KYB) セッションの前に、メタデータを事前登録する場合(パートナー、レベル、社内識別子など)。
  • 既存の企業一覧を保有した状態で、別のKYBベンダーから移行する場合。
  • 取引のみの登録。オフラインのプロセスで確認済みの企業について取引を送信する場合。

注意事項

  • vendor_dataは必須で、アプリケーションごとに一意である必要があります。重複すると競合エラーが返されます。更新するにはPATCH /v3/businesses/{vendor_data}/を使用してください。
  • 登記由来のフィールド(legal_name、registration_number、country_code)は事前登録できますが、最初に承認済みとなった法人確認 (KYB) セッションの登記データによって上書きされます。
  • country_codeがアプリケーションの危険国リストに該当する場合、企業はBLOCKEDステータスで作成されます。
  • business.data.updatedを発行します。

権限

役割にcreate:businessesが付与されている必要があります。

関連情報

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

ボディ

application/json
vendor_data
string | null

この企業に対するお客様独自の識別子です(自由形式の文字列で、UUIDではありません)。任意ですが、指定を強く推奨します。指定する場合は、アプリケーション内の削除されていない企業の間で一意である必要があり、送信されたとおりに完全一致で照合されます。

display_name
string | null

コンソールに表示されるわかりやすい表示名(UI表示ではlegal_nameより優先されます)。

Maximum string length: 255

企業の正式な法人名。

Maximum string length: 255
registration_number
string | null

法人の登記番号または設立番号。

Maximum string length: 100
country_code
string | null

設立国(ISO 3166-1 alpha-2、例: GB、US)。

Maximum string length: 10
status
enum<string>
デフォルト:ACTIVE

初期のライフサイクルステータス。デフォルトはACTIVEです。

利用可能なオプション:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

企業に付与する任意のJSONオブジェクト。デフォルトは{}です。

レスポンス

企業を作成しました。企業の完全なレコードが返されます(Get Businessと同じ形式)。

企業の完全な詳細。BusinessListItemにmetadataとupdated_atを追加したものです。

didit_internal_id
string<uuid>

この企業に対するDiditの安定した内部UUIDです。

vendor_data
string | null

この企業に対するお客様独自の識別子です(セッション作成時に渡されたもの)。ベンダー識別子が指定されなかった場合はnullになることがあります。

display_name
string | null

お客様が設定したカスタム表示名

登記簿または手動入力による正式な法人名

registration_number
string | null

会社の登記番号または設立番号

country_code
string | null

設立国(ISO 3166-1 alpha-2、例: GB、US)。

effective_name
string | null

利用可能な最適な名前:display_nameが設定されていればそれを、設定されていなければlegal_nameを使用

status
enum<string>

企業レコードのライフサイクルステータス(セッションのステータスではありません)。ACTIVEがデフォルトで、FLAGGEDは手動での確認対象としてマークし、BLOCKEDはこのvendor_dataでの新規セッションを禁止します。

利用可能なオプション:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

この企業の認証セッションの総数

approved_count
integer

承認済みセッションの数

declined_count
integer

却下されたセッションの数

in_review_count
integer

レビュー中のセッション数

features
object

この企業のすべてのKYBセッションを通じた、機能ごとの集計ステータスです。現在のキーはKYB(登記上の企業チェックのステータス)のみです。取り得る値はApproved、Declined、In Review、Not Finished、Resub Requestedです。

features_list
object[]

featuresと同じデータを、{feature, status}オブジェクトの順序付き配列で表したもの。

last_session_at
string<date-time> | null

直近のセッションの日時

first_session_at
string<date-time> | null

最初のセッションの日時

last_activity_at
string<date-time> | null

直近のアクティビティ(ステータス変更、セッション更新など)の日時

tags
object[]

この企業に割り当てられたタグ

created_at
string<date-time>
metadata
object

この企業に付加したカスタムメタデータJSON。デフォルトは{}です。

updated_at
string<date-time>
最終更新日 2026年11月1日