Get Business - Didit Documentation

curl

curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \
  -H 'x-api-key: YOUR_API_KEY'

{
  "didit_internal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "vendor_data": "company-123",
  "display_name": null,
  "legal_name": "Acme Trading Ltd",
  "registration_number": "12345678",
  "country_code": "GB",
  "effective_name": "Acme Trading Ltd",
  "status": "ACTIVE",
  "session_count": 2,
  "approved_count": 1,
  "declined_count": 0,
  "in_review_count": 1,
  "features": {
    "KYB_REGISTRY": "Approved",
    "KYB_AML": "Approved"
  },
  "features_list": [
    {
      "feature": "KYB_REGISTRY",
      "status": "Approved"
    },
    {
      "feature": "KYB_AML",
      "status": "Approved"
    }
  ],
  "last_session_at": "2026-03-15T10:30:00Z",
  "first_session_at": "2026-01-10T08:00:00Z",
  "last_activity_at": "2026-03-15T10:30:00Z",
  "tags": [],
  "created_at": "2026-01-10T08:00:00Z",
  "metadata": {
    "industry": "fintech"
  },
  "comments": [
    {
      "uuid": "c1111111-2222-3333-4444-555555555555",
      "comment_type": "status_change",
      "comment": "Verified after KYB review",
      "actor_email": "analyst@company.com",
      "actor_name": "Jane Smith",
      "previous_status": "FLAGGED",
      "new_status": "ACTIVE",
      "created_at": "2026-03-15T10:30:00Z"
    }
  ],
  "updated_at": "2026-03-15T10:30:00Z"
}

GET

businesses

{vendor_data}

curl

curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \
  -H 'x-api-key: YOUR_API_KEY'

{
  "didit_internal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "vendor_data": "company-123",
  "display_name": null,
  "legal_name": "Acme Trading Ltd",
  "registration_number": "12345678",
  "country_code": "GB",
  "effective_name": "Acme Trading Ltd",
  "status": "ACTIVE",
  "session_count": 2,
  "approved_count": 1,
  "declined_count": 0,
  "in_review_count": 1,
  "features": {
    "KYB_REGISTRY": "Approved",
    "KYB_AML": "Approved"
  },
  "features_list": [
    {
      "feature": "KYB_REGISTRY",
      "status": "Approved"
    },
    {
      "feature": "KYB_AML",
      "status": "Approved"
    }
  ],
  "last_session_at": "2026-03-15T10:30:00Z",
  "first_session_at": "2026-01-10T08:00:00Z",
  "last_activity_at": "2026-03-15T10:30:00Z",
  "tags": [],
  "created_at": "2026-01-10T08:00:00Z",
  "metadata": {
    "industry": "fintech"
  },
  "comments": [
    {
      "uuid": "c1111111-2222-3333-4444-555555555555",
      "comment_type": "status_change",
      "comment": "Verified after KYB review",
      "actor_email": "analyst@company.com",
      "actor_name": "Jane Smith",
      "previous_status": "FLAGGED",
      "new_status": "ACTIVE",
      "created_at": "2026-03-15T10:30:00Z"
    }
  ],
  "updated_at": "2026-03-15T10:30:00Z"
}

Overview

Returns a single Business entity keyed by vendor_data.

When to use it

Lookup a business’s current verification state — the features map gives you the latest status of every KYB feature at a glance.
Detail views in your own admin UI.
Risk scoring using aggregate counters and feature statuses.

Notes

vendor_data in the URL is case-sensitive.
Returns 404 if no business with that vendor_data exists.
Aggregate counters (session_count, approved_count, declined_count, in_review_count) update in real time as Business Verification (KYB) sessions complete.
Registry-derived fields (legal_name, registration_number, country_code) reflect the latest approved Business Verification (KYB) session.

Permissions

Role must grant read:businesses.

Authorizations

x-api-key

string

header

required

Path Parameters

vendor_data

string

required

Your unique identifier for the business — a free-form string (NOT a UUID). Matching is case-insensitive after Didit normalisation.

Response

Full business detail including metadata, comments/activity log, and all session data.

Full business detail. Extends BusinessListItem with metadata and comments.

didit_internal_id

string<uuid>

Didit's stable internal UUID for this business.

vendor_data

string | null

Your unique identifier for this business (passed when creating sessions). This can be null when no vendor identifier was supplied.

display_name

string | null

Custom display name set by you

legal_name

string | null

Official legal name from registry or manual entry

registration_number

string | null

Company registration or incorporation number

country_code

string | null

Country of incorporation (ISO 3166-1 alpha-2, e.g. GB, US).

region

string | null

ISO 3166-2 subdivision code (e.g. CA, NY for US states).

effective_name

string | null

Best available name: display_name if set, otherwise legal_name

status

enum<string>

Current status of this business

Available options:

Active,

Flagged,

Blocked

session_count

integer

Total number of verification sessions for this business

approved_count

integer

Number of approved sessions

declined_count

integer

Number of declined sessions

in_review_count

integer

Number of sessions in review

features

object

Map of feature name to latest status, e.g. {"KYB_REGISTRY": "Approved", "KYB_AML": "Approved"}

features_list

object[]

Same as features but as an array of {feature, status} objects

Show child attributes

last_session_at

string<date-time> | null

Timestamp of the most recent session

first_session_at

string<date-time> | null

Timestamp of the first session

last_activity_at

string<date-time> | null

Timestamp of the most recent activity (status change, session update, etc.)

​Overview

​When to use it

​Notes

​Permissions

​Related

Authorizations

Path Parameters

Response

Overview

When to use it

Notes

Permissions

Related