Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.didit.me/llms.txt

Use this file to discover all available pages before exploring further.

This page documents every field on a Business entity and how Didit populates each one.

​
Identity fields

FieldTypeDescription
uuidUUIDDidit-assigned primary key. Stable and unique.
didit_internal_idstringHuman-readable internal identifier.
vendor_datastringYour identifier for the business. Unique per application. Read more.
display_namestringOverride name shown in the console. Defaults to legal_name or vendor_data.
legal_namestringLegal company name as registered — propagated from the latest approved Business Verification (KYB) session’s registry lookup.
registration_numberstringOfficial company registration number — propagated from registry.
country_codestring (ISO 3166-1 alpha-3)Country of incorporation.
legal_name, registration_number, and country_code are read-only when derived from a verified registry lookup. They can be manually overridden in the console or via PATCH /v3/businesses/{vendor_data}/, but overrides are flagged in the audit log.

​
Status

FieldTypeValuesDescription
statusenumACTIVE, FLAGGED, BLOCKEDControls enforcement for future sessions and transactions. See lifecycle.

​
Session aggregate fields

FieldTypeDescription
session_countintTotal Business Verification (KYB) sessions ever created for this business
approved_countintSessions finished with APPROVED
declined_countintSessions finished with DECLINED
in_review_countintSessions currently IN_REVIEW
featuresobjectLatest status of each KYB feature across sessions

​
The features map

{
  "kyb_registry": "APPROVED",
  "kyb_company_aml": "APPROVED",
  "kyb_documents": "APPROVED",
  "kyb_key_people": "IN_REVIEW"
}
Feature values: NOT_FINISHED, APPROVED, DECLINED, IN_REVIEW, RESUB_REQUESTED. Use the features map as the fast path to check whether a business is fully verified right now without iterating all sessions.

​
Activity timestamps

FieldTypeUpdated when
first_session_atISO timestampFirst Business Verification (KYB) session was created
last_session_atISO timestampMost recent session was created or updated
last_activity_atISO timestampAny change — session, transaction, status, profile, notes
created_atISO timestampEntity row was created
updated_atISO timestampEntity row was last updated

​
Metadata

FieldTypeDescription
metadataobject (JSON)Free-form JSON you control
tags[]arrayConsole/API-managed tags

​
Relations (not stored on the business row)

RelationHow to access
Business Verification (KYB) sessionsGET /v3/sessions?vendor_data=<value>
Linked users (officers, UBOs, directors)Surfaced on the business detail page in the console; derived from the latest approved Business Verification (KYB) session
Transactions (as applicant or counterparty)Filter transactions by business vendor_data
DocumentsVia Business Verification (KYB) session decisions
AML hitsVia Business Verification (KYB) session decisions

​
Example response

{
  "uuid": "f7a9c1b2-4e6d-4f8a-9c5d-2a1b3c4d5e6f",
  "didit_internal_id": "B-2026-00018",
  "vendor_data": "biz-acme",
  "display_name": "Acme Corp",
  "legal_name": "Acme Corporation Limited",
  "registration_number": "12345678",
  "country_code": "GBR",
  "status": "ACTIVE",
  "session_count": 2,
  "approved_count": 1,
  "declined_count": 0,
  "in_review_count": 1,
  "features": {
    "kyb_registry": "APPROVED",
    "kyb_company_aml": "APPROVED",
    "kyb_documents": "APPROVED",
    "kyb_key_people": "IN_REVIEW"
  },
  "first_session_at": "2025-09-01T12:00:00Z",
  "last_session_at": "2026-04-01T09:00:00Z",
  "last_activity_at": "2026-04-16T10:00:00Z",
  "metadata": { "partner": "Acme Holdings" }
}

​
Next steps

Operations

Create, update, change status, delete.

KYB history

Retrieve every session tied to the business.

API reference

GET /v3/businesses// schema.