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

概要

企業のステータスをACTIVE、FLAGGED、BLOCKEDの間で変更します。ステートマシンの全体像はエンティティのライフサイクルを参照してください。

使用するタイミング

  • 制裁対象の企業や不正が確認された企業をブロックする。
  • 手動レビュー待ちの企業にフラグを立てる。
  • 是正後にブロックを解除する。
  • 自社のコンプライアンスシステムからの外部シグナルを反映する。

注意事項

  • 有効な値はACTIVE、FLAGGED、BLOCKEDです。
  • 任意のreason(最大1000文字)を渡すと、ステータスを変更した理由を記録できます。 Diditはこれを、Business Consoleにおけるその企業のActivityのステータス変更エントリに保存します。 記録されるのは、ステータスが実際に変更された場合のみです。
  • BLOCKEDの企業では、新しい法人確認 (KYB) セッションがすべて自動的に却下され、新しい取引も、その企業が取引相手となる場合を含めてすべて自動的に却下されます。
  • previous_statusとstatusを含む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
status
enum<string>
必須

新しいライフサイクルステータス。BLOCKEDを指定すると、vendor_dataもシステムのブロックリストに追加されます。

利用可能なオプション:
ACTIVE,
FLAGGED,
BLOCKED
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日