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

# List Businesses

> List [businesses](/entities/businesses) Didit assembles from KYB sessions sharing the same `vendor_data` (free-form string, NOT a UUID), plus businesses created via the API. Paginated, ordered by `last_session_at` desc. This endpoint does not support filtering or search parameters — fetch pages and filter client-side.

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="List Businesses Prompt"
  prompt={`Goal: Page through Didit Business (KYB) entities for an application and consume them in your backend.

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

Query params (all optional):
- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices, NOT the session enum).
- search: free-text over vendor_data, display_name, legal_name, registration_number.
- country: country of incorporation, ISO 3166-1 alpha-2 (e.g. "GB", "US").
- limit: integer, 1–200, default 50.
- offset: integer, 0+, default 0. Prefer following the "next" URL from the previous page.

curl:
curl -X GET 'https://verification.didit.me/v3/businesses/?limit=50&status=ACTIVE' \\
-H 'x-api-key: YOUR_API_KEY'

Response 200 (envelope):
{
"count": <int — exact up to 100, capped above; pagination still works via "next">,
"next": <URL or null>,
"previous": <URL or null>,
"results": [ BusinessListItem, ... ]
}

BusinessListItem key fields: didit_internal_id (UUID), vendor_data (string, may be null), display_name, legal_name, registration_number, country_code, effective_name, status, session_count, approved_count, declined_count, in_review_count, features (map: KYB_REGISTRY, KYB_AML, KYB_DOCUMENTS, ... -> latest status), features_list, last_session_at, first_session_at, last_activity_at, tags, created_at. See /reference/data-models for the full shape.

Notes:
- Ordered by last_session_at desc.
- Soft-deleted businesses are hidden from this list (retained internally up to 180 days).
- vendor_data is a free-form client-supplied string, NOT a UUID; may be null when the originating session didn't provide one.

Pagination loop:
url = 'https://verification.didit.me/v3/businesses/?limit=200&status=FLAGGED'
while url:
r = requests.get(url, headers={'x-api-key': API_KEY})
r.raise_for_status()
page = r.json()
for biz in page['results']:
    ...
url = page['next']

Failure modes (envelope {"detail": "..."}):
- 401 — missing/invalid x-api-key.
- 403 — key lacks list:businesses.
- 429 — rate-limited.

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

## Overview

Returns a paginated list of [Business entities](/entities/businesses/overview) for the authenticated application.

## When to use it

* **Sync** your business table to an external BI or warehouse.
* **Analyst queues** — filter by `status=FLAGGED` to drive a review inbox.
* **Search** by `display_name`, `legal_name`, `registration_number`, or `vendor_data`.

## Filters and pagination

| Query parameter                               | Description                                                              |
| --------------------------------------------- | ------------------------------------------------------------------------ |
| `status`                                      | `ACTIVE`, `FLAGGED`, or `BLOCKED`.                                       |
| `search`                                      | Substring match on display name, legal name, registration, vendor\_data. |
| `country_code`                                | ISO 3166-1 alpha-3 country of incorporation.                             |
| `created_after`, `created_before`             | Creation date window.                                                    |
| `last_activity_after`, `last_activity_before` | Activity window.                                                         |
| `page_size`                                   | 1–200. Default 50.                                                       |
| `cursor`                                      | Pagination cursor.                                                       |

## Notes

* `vendor_data` may be `null` if the originating session or transaction did not provide one.
* Cursor-based pagination — persist the `next` cursor between calls.
* See the [Business data model](/entities/businesses/data-model) for every field.

## Permissions

Role must grant `list:businesses`.

## Related

* [Businesses overview](/entities/businesses/overview)
* [Get business](/management-api/businesses/get)
* [Business operations](/entities/businesses/operations)


## OpenAPI

````yaml GET /v3/businesses/
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/:
    get:
      tags:
        - Businesses
      summary: List businesses
      description: >-
        List [businesses](/entities/businesses) Didit assembles from KYB
        sessions sharing the same `vendor_data` (free-form string, NOT a UUID),
        plus businesses created via the API. Paginated, ordered by
        `last_session_at` desc. This endpoint does not support filtering or
        search parameters — fetch pages and filter client-side.
      operationId: list_businesses
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
          description: >-
            Page size. Defaults to 50 when omitted. There is no enforced
            maximum, but keep pages small for latency.
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: >-
            Zero-based offset of the first record to return. Prefer following
            the `next` URL from the previous page over computing this by hand.
      responses:
        '200':
          description: >-
            Paginated list of businesses with status, session counts, and
            feature breakdown.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Number of matching rows — exact up to 100, capped at 100
                      beyond that for performance. Do not use it to detect the
                      last page; rely on `next` being `null` instead.
                  next:
                    type: string
                    nullable: true
                    description: Absolute URL of the next page, or `null` on the last page.
                  previous:
                    type: string
                    nullable: true
                    description: >-
                      Absolute URL of the previous page, or `null` on the first
                      page.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/BusinessListItem'
              examples:
                Example:
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - 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'
        '403':
          description: >-
            Missing, invalid, or revoked API key, or the key cannot list
            businesses for this application. 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.
        '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/?limit=50'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            import requests

            resp = requests.get(
                'https://verification.didit.me/v3/businesses/',
                headers={'x-api-key': 'YOUR_API_KEY'},
                params={'limit': 50},
            )
            resp.raise_for_status()
            page = resp.json()
            for biz in page['results']:
                print(biz['vendor_data'], biz['status'])
        - lang: javascript
          label: JavaScript
          source: |-
            const url = new URL('https://verification.didit.me/v3/businesses/');
            url.searchParams.set('limit', '50');

            const page = await fetch(url, {
              headers: { 'x-api-key': process.env.DIDIT_API_KEY },
            }).then((r) => r.json());
            console.log(page.count, page.results.length);
components:
  schemas:
    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

````