> ## 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 API: получение KYB-компании по vendor_data > Получите компанию Didit (KYB) по vendor_data: реестровые данные, статус, счётчики KYB и карта features. Оплата за вызов. Промпт: получение компании Скопировать промпт в буфер обмена \

\`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: 

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

\
Вставьте в ## ОбзорВозвращает одну [сущность компании](https://docs.didit.me/ru/entities/businesses/overview.md) по `vendor_data`.## Когда использовать- **Проверка** текущего состояния верификации компании: карта `features` показывает последний статус каждой функции KYB. - **Детальные представления** в вашей собственной панели администратора. - **Скоринг рисков** с использованием совокупных счётчиков и статусов функций.## Примечания- `vendor_data` в URL чувствителен к регистру. - Возвращает `404`, если компании с таким `vendor_data` не существует. - Совокупные счётчики (`session_count`, `approved_count`, `declined_count`, `in_review_count`) обновляются в реальном времени по мере завершения сессий верификации бизнеса (KYB). - Поля, полученные из реестра (`legal_name`, `registration_number`, `country_code`), отражают последнюю одобренную сессию верификации бизнеса (KYB).## РазрешенияРоль должна предоставлять `read:businesses`.## Связанные материалы- [Обзор компаний](https://docs.didit.me/ru/entities/businesses/overview.md) - [Модель данных](https://docs.didit.me/ru/entities/businesses/data-model.md) - [Список компаний](https://docs.didit.me/ru/management-api/businesses/list.md) ## OpenAPI ````yaml ru/openapi-25.json GET /v3/businesses/{vendor_data}/ 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/{vendor_data}/: get: tags: - Businesses summary: Получить компанию description: >- Получить одну [компанию](/entities/businesses) по `vendor_data` (точное совпадение). Добавляет `metadata` и `updated_at` к списочному представлению. Удалённые компании возвращают 404. operationId: get_business parameters: - name: vendor_data in: path required: true schema: type: string description: >- Ваш уникальный идентификатор компании — произвольная строка (НЕ UUID), сопоставляется в точности в переданном виде. example: company-123 responses: '200': description: >- Полные сведения о компании, включая метаданные и агрегированные данные сессий. 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: >- Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на чтение компаний этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: >- Для этого приложения не найдена (неудалённая) компания с указанным `vendor_data`. content: application/json: examples: Not found: value: detail: Not found. '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/company-123/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.businesses.retrieve( "company-123", ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.businesses.retrieve("company-123"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Retrieve(ctx, \"company-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.businesses().retrieve("company-123"); System.out.println(result); - lang: php label: PHP source: |- businesses->retrieve('company-123'); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.businesses.retrieve("company-123") puts result.to_h - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Businesses.RetrieveAsync("company-123"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: BusinessDetailItem: type: object description: >- Полные сведения о компании. Расширяет BusinessListItem метаданными и updated_at. allOf: - $ref: '#/components/schemas/BusinessListItem' - type: object properties: metadata: type: object description: >- JSON с пользовательскими метаданными, прикреплённый вами к этой компании. По умолчанию `{}`. updated_at: type: string format: date-time 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.