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

# API списка компаний: сущности KYB поставщиков

> Получайте все сущности Didit Business (KYB) вашего приложения с фильтрами по статусу, стране, поиску и дате. Программное управление жизненным циклом KYB.



Промпт для получения списка компаний
        Скопировать промпт в буфер обмена



      
      

\<pre>

\`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.
\- Deleted businesses are not returned.
\- 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.`

\</pre>



      
      

Вставьте в

## ОбзорВозвращает постраничный список [сущностей компаний](https://docs.didit.me/ru/entities/businesses/overview.md) для авторизованного приложения.## Когда использовать- **Синхронизируйте** таблицу компаний с внешним BI или хранилищем данных.
- **Очереди для аналитиков**: фильтруйте по `status=FLAGGED`, чтобы формировать очередь на проверку.
- **Поиск** по `display_name`, `legal_name`, `registration_number` или `vendor_data`.## Фильтры и пагинация| Параметр запроса | Описание |
| - | - |
| `status` | `ACTIVE`, `FLAGGED` или `BLOCKED`. |
| `search` | Поиск по подстроке в отображаемом имени, юридическом наименовании, регистрационном номере и vendor\_data. |
| `country_code` | Страна регистрации в формате ISO 3166-1 alpha-3. |
| `created_after`, `created_before` | Диапазон дат создания. |
| `last_activity_after`, `last_activity_before` | Период последней активности. |
| `page_size` | 1–200. По умолчанию 50. |
| `cursor` | Курсор пагинации. |## Примечания- `vendor_data` может быть `null`, если исходная сессия или транзакция не передали его.
- Пагинация на основе курсора: сохраняйте курсор `next` между вызовами.
- Все поля описаны в [модели данных компании](https://docs.didit.me/ru/entities/businesses/data-model.md).## Права доступаРоль должна предоставлять `list:businesses`.## Связанные материалы- [Обзор компаний](https://docs.didit.me/ru/entities/businesses/overview.md)
- [Получение компании](https://docs.didit.me/ru/management-api/businesses/get.md)
- [Операции с компаниями](https://docs.didit.me/ru/entities/businesses/operations.md)


## OpenAPI

````yaml ru/openapi-25.json GET /v3/businesses/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: >-
    API верификации личности. Аутентификация выполняется с помощью заголовка
    x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/:
    get:
      tags:
        - Businesses
      summary: Получить список компаний
      description: >-
        Получить список [компаний](/entities/businesses), которые Didit
        формирует на основе сессий KYB с одинаковым значением `vendor_data`
        (произвольная строка, НЕ UUID), а также компаний, созданных через API. С
        пагинацией, отсортирован по `last_session_at` по убыванию (desc). Этот
        endpoint не поддерживает параметры фильтрации или поиска — запрашивайте
        страницы и фильтруйте на стороне клиента.
      operationId: list_businesses
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
          description: >-
            Размер страницы. По умолчанию 50, если не указан. Жёсткого максимума
            нет, но рекомендуется оставлять страницы небольшими для уменьшения
            задержки.
        - name: offset
          in: query
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
          description: >-
            Смещение первой возвращаемой записи, начиная с нуля. Рекомендуется
            переходить по URL `next` с предыдущей страницы вместо вычисления
            вручную.
      responses:
        '200':
          description: >-
            Список компаний с пагинацией, со статусом, количеством сессий и
            детализацией по функциям.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Количество подходящих строк: точное до 100, с ограничением
                      в 100 сверх этого для производительности. Не используйте
                      его для определения последней страницы; вместо этого
                      ориентируйтесь на то, что `next` равен `null`.
                  next:
                    type: string
                    nullable: true
                    description: >-
                      Абсолютный URL следующей страницы или `null` на последней
                      странице.
                  previous:
                    type: string
                    nullable: true
                    description: >-
                      Абсолютный URL предыдущей страницы или `null` на первой
                      странице.
                  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: >-
            Отсутствующий, недействительный или отозванный API-ключ, либо у
            ключа нет прав на получение списка компаний для этого приложения.
            При отсутствии ключа возвращается `403`; при неверном, отозванном
            или истекшем ключе возвращается `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: >-
            Лимит запросов превышен; снизьте частоту запросов и повторите
            попытку через интервал, указанный в `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: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.businesses.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            for await (const item of didit.businesses.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Businesses.ListAutoPaging(ctx, didit.BusinessesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.businesses().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->businesses->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.businesses.list.auto_paging_each do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            await foreach (var item in await client.Businesses.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    BusinessListItem:
      type: object
      description: Верифицированная компания.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: Стабильный внутренний UUID Didit для этой компании.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Ваш уникальный идентификатор этой компании (передаётся при создании
            сессий). Может быть равен null, если идентификатор поставщика не был
            передан.
        display_name:
          type: string
          nullable: true
          description: Пользовательское отображаемое имя, заданное вами
        legal_name:
          type: string
          nullable: true
          description: Официальное юридическое наименование из реестра или ручного ввода
        registration_number:
          type: string
          nullable: true
          description: Регистрационный номер или номер инкорпорации компании
        country_code:
          type: string
          nullable: true
          description: Страна инкорпорации (ISO 3166-1 alpha-2, например, `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: 'Наиболее подходящее имя: display_name, если задано, иначе legal_name'
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Статус жизненного цикла записи компании (НЕ статус сессии). `ACTIVE`
            используется по умолчанию, `FLAGGED` помечает её для ручной
            проверки, `BLOCKED` запрещает новые сессии для этого `vendor_data`.
        session_count:
          type: integer
          description: Общее количество сессий верификации для этой компании
        approved_count:
          type: integer
          description: Количество одобренных сессий
        declined_count:
          type: integer
          description: Количество отклонённых сессий
        in_review_count:
          type: integer
          description: Количество сессий на проверке
        features:
          type: object
          description: >-
            Агрегированный статус по функциям среди всех KYB-сессий этой
            компании. В настоящее время единственным ключом является `KYB`
            (статус проверки компании по реестру). Возможные значения:
            `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub
            Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Те же данные, что и `features`, в виде упорядоченного массива
            объектов `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Временная метка последней сессии
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Временная метка первой сессии
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Временная метка последней активности (смена статуса, обновление
            сессии и т. д.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Теги, назначенные этой компании
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        может иметь ограниченную область действия: без доступа, чтение или
        запись для каждого ресурса, ограничение определенными сценариями или
        одобренными сессиями, списком IP-адресов и сроком действия. 401
        означает, что ключ неверен, отозван или его срок действия истек; 403
        означает, что ключ не был передан, у ключа нет доступа к этому ресурсу
        или действию, либо запрос поступил с адреса вне его списка IP-адресов;
        404 на маршруте сессии означает, что сессия не входит в сценарии или
        статусы ключа. Ключ без доступа к медиа получает URL изображений, видео
        и PDF как null, а ключ без прав на запись сессий получает ссылки на
        сессии и токены как null. См. https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.