Update Business
Partial update of a business: display_name, legal_name, registration_number, country_code, status, metadata. metadata fully replaces. Setting status to BLOCKED adds the vendor_data to the system blocklist; moving away from BLOCKED removes that entry.
Overview
Updates mutable fields on a Business entity. Fields populated from registry lookups (legal_name, registration_number, country_code) become read-only after the first approved Business Verification (KYB) session.
When to use it
- Rename — set a better
display_namefor internal views. - Update metadata — move a business between internal tiers, record an internal note, change tags.
- Override registry data (with caution) — overrides are accepted but flagged in the audit log.
Notes
vendor_datain the URL cannot be changed via this endpoint.- Emits a
business.data.updatedwebhook with achanged_fieldsarray.
Permissions
Role must grantupdate:businesses.
Related
Authorizations
Path Parameters
Your unique identifier for the business (free-form string, NOT a UUID).
Body
Partial-update body. Provide only the fields you want to change.
Friendly display name shown in the console (takes precedence over legal_name for UI display).
Official legal name from registry or manual entry.
Company registration or incorporation number.
Country of incorporation (ISO 3166-1 alpha-2, e.g. GB, US).
Business lifecycle status. Setting BLOCKED automatically adds the vendor_data to the system blocklist; flipping away from BLOCKED removes that blocklist entry.
ACTIVE, FLAGGED, BLOCKED Arbitrary JSON object you attach to the business. Fully replaces the existing metadata on update — merge client-side if you only want to add keys.
Response
Business updated. The full updated business record is returned.
Full business detail. Extends BusinessListItem with metadata and updated_at.
Didit's stable internal UUID for this business.
Your unique identifier for this business (passed when creating sessions). This can be null when no vendor identifier was supplied.
Custom display name set by you
Official legal name from registry or manual entry
Company registration or incorporation number
Country of incorporation (ISO 3166-1 alpha-2, e.g. GB, US).
Best available name: display_name if set, otherwise legal_name
Lifecycle status of the business record (NOT a session status). ACTIVE is the default, FLAGGED marks it for manual attention, BLOCKED prevents new sessions for this vendor_data.
ACTIVE, FLAGGED, BLOCKED Total number of verification sessions for this business
Number of approved sessions
Number of declined sessions
Number of sessions in review
Aggregated per-feature status across all of this business's KYB sessions. Currently the only key is KYB (the registry company check status). Possible values: Approved, Declined, In Review, Not Finished, Resub Requested.
Same data as features, as an ordered array of {feature, status} objects.
Timestamp of the most recent session
Timestamp of the first session
Timestamp of the most recent activity (status change, session update, etc.)
Tags assigned to this business
Custom metadata JSON you attached to this business. Defaults to {}.