Skip to main content
POST
curl

Overview

Deletes one or more Business entities. The business records are removed permanently. Business Verification (KYB) sessions are not covered by this endpoint and survive with their link to the business cleared; delete them with Delete Session. Transactions are not covered either; delete those from the Console.

When to use it

  • Right-to-be-forgotten requests.
  • Clean-up of test businesses during QA.
  • Deprovisioning businesses removed from your own platform.

Notes

  • Accepts a list of vendor_data values or didit_internal_id values.
  • Idempotent — deleting an already-deleted business is a no-op.
  • Returns only a count of what was deleted, not a per-item report. Values that matched nothing are skipped silently.
  • Emits business.data.updated with deleted_at set.
  • Records owned by the business entity itself go with it: its tag links, its comment history, and its own device and network records.
  • Records produced by a KYB session do NOT: company registry data, uploaded documents, AML hits, beneficial owners and key-people checks all belong to the session and survive until you delete the session itself.

Permissions

Role must grant delete:businesses. Typically reserved for OWNER and ADMIN.

Authorizations

x-api-key
string
header
required

Body

application/json

Provide vendor_data_list, didit_internal_id_list, or delete_all: true. Precedence when several are sent: delete_all > vendor_data_list > didit_internal_id_list (only the highest-precedence selector is used).

vendor_data_list
string[]

Your own identifiers to delete, matched exactly as sent.

didit_internal_id_list
string<uuid>[]

Didit's internal UUIDs (didit_internal_id) to delete.

delete_all
boolean
default:false

If true, deletes every business in the application. Cannot be combined with the list selectors.

Response

Businesses deleted. Returns the number of rows actually removed.

deleted
integer

Number of businesses deleted (excludes vendor_data values that didn't match anything).