> ## 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.

# Get Business

> Fetch one [business](/entities/businesses) by `vendor_data` (exact match). Adds `metadata` and `updated_at` to the list view. Soft-deleted businesses return 404.

export const AgentPromptAccordion = ({prompt, title = "AI Agent Integration Prompt"}) => {
  const [copied, setCopied] = React.useState(false);
  const handleCopy = e => {
    e.stopPropagation();
    if (!prompt) return;
    navigator.clipboard.writeText(prompt.trim()).then(() => {
      setCopied(true);
      setTimeout(() => setCopied(false), 2000);
    });
  };
  const agents = ["Claude Code", "Codex", "Cursor", "Devin", "Windsurf", "GitHub Copilot"];
  return <div className="didit-agent-card">
      {}
      <div className="didit-agent-titlebar">
        <div className="didit-agent-dots" aria-hidden="true">
          <span className="didit-agent-dot didit-agent-dot-red"></span>
          <span className="didit-agent-dot didit-agent-dot-yellow"></span>
          <span className="didit-agent-dot didit-agent-dot-green"></span>
        </div>
        <span className="didit-agent-filename">{title}</span>
        <button type="button" className={`didit-agent-copy ${copied ? "didit-agent-copy-copied" : ""}`} onClick={handleCopy} title="Copy prompt to clipboard" aria-label={copied ? "Copied!" : "Copy prompt to clipboard"}>
          {copied ? <>
              <svg width="13" height="13" viewBox="0 0 16 16" fill="none">
                <path d="M3 8.5l3.5 3.5L13 4" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" />
              </svg>
              <span>Copied</span>
            </> : <>
              <svg width="13" height="13" viewBox="0 0 16 16" fill="none">
                <rect x="5" y="5" width="9" height="9" rx="1.5" stroke="currentColor" strokeWidth="1.5" />
                <path d="M11 5V3.5A1.5 1.5 0 0 0 9.5 2h-6A1.5 1.5 0 0 0 2 3.5v6A1.5 1.5 0 0 0 3.5 11H5" stroke="currentColor" strokeWidth="1.5" />
              </svg>
              <span>Copy</span>
            </>}
        </button>
      </div>

      {}
      <pre className="didit-agent-body"><code>{prompt.trim()}</code></pre>

      {}
      <div className="didit-agent-footer">
        <span className="didit-agent-footer-label">Paste into</span>
        <div className="didit-agent-chips">
          {agents.map(name => <span key={name} className="didit-agent-chip">{name}</span>)}
        </div>
      </div>
    </div>;
};

<AgentPromptAccordion
  title="Get Business Prompt"
  prompt={`Goal: Fetch a single Didit Business (KYB) entity by your own vendor_data.

Endpoint: GET https://verification.didit.me/v3/businesses/{vendor_data}/
Auth header: x-api-key: <DIDIT_API_KEY>

Path param:
- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after normalisation. URL-encode it.

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

Response 200 (BusinessDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
- didit_internal_id (UUID — Didit's stable internal identifier)
- vendor_data (string)
- display_name, legal_name, registration_number, country_code, region, effective_name
- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices)
- session_count, approved_count, declined_count, in_review_count (aggregate counters)
- features (map: KYB_REGISTRY, KYB_AML, KYB_DOCUMENTS, ... -> latest status)
- metadata (arbitrary JSON you attached)
- comments (chronological activity log)
- tags, created_at, updated_at, last_activity_at
See /reference/data-models for the full schema.

Notes:
- Aggregate counters update in real time as Business Verification (KYB) sessions reach terminal status.
- Registry-derived fields reflect the latest approved KYB session's registry data.
- For bulk lookups, prefer paging GET /v3/businesses/ and indexing locally on vendor_data.

Failure modes (envelope {"detail": "..."}):
- 401 — missing/invalid x-api-key.
- 403 — lacks read:businesses.
- 404 — no business with that vendor_data in this application.
- 429 — rate-limited.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`}
/>

## Overview

Returns a single [Business entity](/entities/businesses/overview) 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`.

## Related

* [Businesses overview](/entities/businesses/overview)
* [Data model](/entities/businesses/data-model)
* [List businesses](/management-api/businesses/list)


## OpenAPI

````yaml GET /v3/businesses/{vendor_data}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: Identity verification API. Authenticate with x-api-key header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/:
    get:
      tags:
        - Businesses
      summary: Get business
      description: >-
        Fetch one [business](/entities/businesses) by `vendor_data` (exact
        match). Adds `metadata` and `updated_at` to the list view. Soft-deleted
        businesses return 404.
      operationId: get_business
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Your unique identifier for the business — a free-form string (NOT a
            UUID), matched exactly as sent.
          example: company-123
      responses:
        '200':
          description: Full business detail including metadata and aggregated session data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessDetailItem'
              examples:
                Active business:
                  value:
                    didit_internal_id: a1b2c3d4-e5f6-4890-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: Approved
                    features_list:
                      - feature: KYB
                        status: Approved
                    last_session_at: '2026-03-15T10:30:00Z'
                    last_activity_at: '2026-03-15T10:30:00Z'
                    first_session_at: '2026-01-10T08:00:00Z'
                    tags:
                      - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
                        name: VIP
                        color: '#2567FF'
                    created_at: '2026-01-10T08:00:00Z'
                    metadata:
                      industry: fintech
                    updated_at: '2026-03-15T10:30:00Z'
        '403':
          description: >-
            Missing, invalid, or revoked API key, or the key cannot read this
            application's businesses. This endpoint returns `403` (never `401`)
            for authentication failures, including requests with no credentials
            at all.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            No (non-deleted) business with the supplied `vendor_data` exists for
            this application.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Rate limit exceeded; back off and retry after the interval indicated
            in `Retry-After`.
          content:
            application/json:
              examples:
                Rate limited:
                  value:
                    detail: Request was throttled. Expected available in 30 seconds.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/businesses/company-123/' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            import requests

            resp = requests.get(
                'https://verification.didit.me/v3/businesses/company-123/',
                headers={'x-api-key': 'YOUR_API_KEY'},
            )
            resp.raise_for_status()
            biz = resp.json()
            print(biz['didit_internal_id'], biz['status'])
        - lang: javascript
          label: JavaScript
          source: |-
            const vendorData = encodeURIComponent('company-123');
            const biz = await fetch(
              `https://verification.didit.me/v3/businesses/${vendorData}/`,
              { headers: { 'x-api-key': process.env.DIDIT_API_KEY } },
            ).then((r) => r.json());
            console.log(biz.didit_internal_id, biz.status);
components:
  schemas:
    BusinessDetailItem:
      type: object
      description: >-
        Full business detail. Extends BusinessListItem with metadata and
        updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                Custom metadata JSON you attached to this business. Defaults to
                `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: A verified business.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: Didit's stable internal UUID for this business.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Your unique identifier for this business (passed when creating
            sessions). This can be null when no vendor identifier was supplied.
        display_name:
          type: string
          nullable: true
          description: Custom display name set by you
        legal_name:
          type: string
          nullable: true
          description: Official legal name from registry or manual entry
        registration_number:
          type: string
          nullable: true
          description: Company registration or incorporation number
        country_code:
          type: string
          nullable: true
          description: Country of incorporation (ISO 3166-1 alpha-2, e.g. `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: 'Best available name: display_name if set, otherwise legal_name'
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            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`.
        session_count:
          type: integer
          description: Total number of verification sessions for this business
        approved_count:
          type: integer
          description: Number of approved sessions
        declined_count:
          type: integer
          description: Number of declined sessions
        in_review_count:
          type: integer
          description: Number of sessions in review
        features:
          type: object
          description: >-
            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`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Same data as `features`, as an ordered array of `{feature, status}`
            objects.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp of the most recent session
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp of the first session
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Timestamp of the most recent activity (status change, session
            update, etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Tags assigned to this business
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````