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

概要

1件以上の企業を削除します。企業のレコードは完全に削除されます。企業確認 (KYB)セッションはこのエンドポイントの対象外で、企業との紐付けが解除された状態で残ります。これらはセッションの削除で削除してください。取引も対象外です。取引は取引の一括削除で削除してください。

使用する場面

  • 忘れられる権利の行使に基づくリクエスト。
  • QA中に作成したテスト用企業のクリーンアップ。
  • 自社プラットフォームから削除された企業のプロビジョニング解除。

注意事項

  • vendor_dataの値またはdidit_internal_idの値のリストを受け付けます。
  • 冪等性があります。すでに削除された企業を削除しても何も起こりません。
  • 削除された件数のみを返し、項目ごとのレポートは返しません。何にも一致しなかった値は通知なくスキップされます。
  • deleted_atが設定されたbusiness.data.updatedを送信します。
  • 企業エンティティ自体が所有するレコードは、企業とともに削除されます。対象は、タグの紐付け、コメント履歴、企業自身のデバイスおよびネットワークのレコードです。
  • KYBセッションによって生成されたレコードは削除されません。法人登記データ、アップロードされた書類、AMLのヒット、実質的支配者および主要人物のチェックはすべてセッションに属し、セッション自体を削除するまで残ります。

確定済みの規制当局向けレポートに含まれるデータ

選択した企業のいずれかが、確定済みの規制当局向けレポートを持つケースに含まれている場合、リクエスト全体が409を返し、何も削除されません。レスポンスではcode: in_filed_reportが使用され、各レポートの名前が示されます。
レポートの削除で各レポートを削除してから、同じリクエストを再度実行してください。

権限

役割にはdelete:businessesが付与されている必要があります。通常はOWNERとADMINに限定されます。

関連情報

承認

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_list、didit_internal_id_list、またはdelete_all: trueを指定してください。複数を送信した場合の優先順位はdelete_all > vendor_data_list > didit_internal_id_listです(最も優先度の高いセレクターのみが使用されます)。

vendor_data_list
string[]

削除するお客様独自の識別子で、送信した値と完全一致で照合されます。

didit_internal_id_list
string<uuid>[]

削除するDiditの内部UUID(didit_internal_id)です。

delete_all
boolean
デフォルト:false

trueの場合、アプリケーション内のすべての企業を削除します。リストによる選択指定と併用することはできません。

レスポンス

企業を削除しました。実際に削除された行数が返されます。

deleted
integer

削除された企業の数(どれにも一致しなかったvendor_dataの値は含みません)。

最終更新日 2026年11月1日