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

概要

企業エンティティの変更可能なフィールドを更新します。法人登記の照会から取得されたフィールド(legal_name、registration_number、country_code)は、最初の法人認証 (KYB) セッションが承認済みになった後は読み取り専用になります。

使用するタイミング

  • 名前を変更: 社内向けの表示用に、より適切なdisplay_nameを設定します。
  • メタデータの更新: 企業を社内のレベル間で移動する、社内メモを記録する、タグを変更する、といった用途に使います。
  • 法人登記データの上書き(注意して使用): 上書きは受け付けられますが、監査ログでフラグが付けられます。

注意事項

  • URL内のvendor_dataは、このエンドポイントでは変更できません。
  • changed_fields配列を含むbusiness.data.updated Webhookを送信します。
  • すべての編集は、Business Consoleの企業のActivityに記録されます。 statusの変更は指定されている場合はreason(最大1000文字)とともに記録され、display_name、legal_name、registration_number、country_codeまたはmetadataの変更はプロフィールの更新として記録されます。 business.status.updated Webhookにはreasonは含まれません。

権限

プライマリシークレットとフルアクセスのAPIキーは、常にこのエンドポイントを呼び出せます。 カスタムアクセスのキーには、Companies(businesses)の書き込み権限が必要です。 一部のワークフローまたは承認済みセッションに制限されたキーは、このエンドポイントにアクセスできません。 Consoleの役割と権限は、チームメンバーがConsoleで実行できる操作を決めるものです。 APIキーによるリクエストでは評価されません。

関連情報

承認

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

パスパラメータ

vendor_data
string
必須

企業に対するお客様独自の識別子です(自由形式の文字列で、UUIDではありません)。

ボディ

application/json

部分更新ボディ。変更したいフィールドのみを指定してください。

display_name
string | null

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

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

registration_number
string | null

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

country_code
string | null

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

status
enum<string>

企業のライフサイクルステータス。BLOCKEDを設定すると、vendor_dataが自動的にシステムのブロックリストに追加されます。BLOCKEDから別のステータスに変更すると、そのブロックリストのエントリは削除されます。

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

企業に付与する任意のJSONオブジェクト。更新時には既存のメタデータを完全に置き換えます。キーを追加したいだけの場合は、クライアント側でマージしてください。

reason
string | null

ステータスが変更された理由。Business Consoleの企業のActivityにあるステータス変更エントリに記録されます。記録されるのは、ステータスが実際に変わった場合のみです。Webhookには含まれません。

Maximum string length: 1000

レスポンス

企業を更新しました。更新後の企業の完全なレコードが返されます。

企業の完全な詳細。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日