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

# Привязка vendor_data: связывание ID с сущностями

> Идентификатор vendor_data связывает вашу систему с Didit: сессии, транзакции и сущности User/Business объединяются в один профиль. Оплата за вызов.

Промпт для связывания vendor\_data
Скопировать промпт в буфер обмена

<pre>
  \`\`\`\`# Goal — link every session, transaction, and entity together using `vendor_data`

  `vendor_data` is the string identifier you choose and pass on every API call to bind it to a persistent [User](https://docs.didit.me/entities/users/overview.md) or [Business](https://docs.didit.me/entities/businesses/overview.md) entity. Get this right once and you never have to re-key history afterwards.

  ## Rules

  * `vendor_data` is **opaque** to Didit. Use your stable internal customer id.
  * Choose one canonical id per entity and never change it. Changing it orphans history under a new entity.
  * Prefix by entity type when convenient (`user_...`, `biz_...`) to avoid collisions in your own code.
  * Keep it under 128 chars, case-sensitive stable. Hard limit is 2000 bytes (UTF-8 encoded) - anything over that is rejected with a 400 rather than accepted.
  * **Never put raw PII in it** — it surfaces in webhooks, logs, and API responses.
  * Uniqueness is per application × entity type. User `user-42` and Business `user-42` are different entities (but don't do this).

  ## Where it goes

  | API | Field |
  | - | - |
  | `POST /v3/session/` | top-level `vendor_data` (KYC and KYB) |
  | `POST /v3/transactions/` | top-level `vendor_data` and `applicant.vendor_data` / `counterparty.vendor_data` |
  | `POST /v3/users/create/` / `POST /v3/businesses/create/` | `vendor_data` |
  | `GET /v3/sessions?vendor_data=...` | query param to retrieve history |
  | `GET /v3/users/{vendor_data}/` / `GET /v3/businesses/{vendor_data}/` | path param |

  ## Pattern — pre-create the entity, then run a session

  ```bash
  # 1) Seed the entity with metadata before any session
  curl -X POST https://verification.didit.me/v3/users/create/ \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "vendor_data": "user-42",
  "display_name": "Jane Doe",
  "metadata": {"tier": "premium", "signup_date": "2026-04-01"}
  }'

  # 2) Run a KYC session linked to the same entity
  curl -X POST https://verification.didit.me/v3/session/ \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "workflow_id": "$WORKFLOW_ID",
  "vendor_data": "user-42",
  "callback": "https://myapp.com/return"
  }'

  # 3) Later, retrieve every session for the entity
  curl -G https://verification.didit.me/v3/sessions/ \
  -H "x-api-key: $DIDIT_API_KEY" \
  --data-urlencode "vendor_data=user-42"
  ```

  ## Auto-create semantics

  If you create a session with a new `vendor_data` and no entity exists, Didit creates the entity automatically with `status: ACTIVE` and links the session.

  ## Failure modes

  * Missing `vendor_data` on session create → session is orphaned, won't appear in any entity profile, cannot be filtered by `vendor_data` later (only by `session_id`).
  * Different case (`User-42` vs `user-42`) → two separate entities. Pick a casing convention and stick to it.
  * Same `vendor_data` across staging and prod apps → no collision; `vendor_data` is scoped per application.

  ## Sources of truth

  * /entities/users/operations — full User CRUD
  * /entities/businesses/operations — full Business CRUD
  * /sessions-api/create-session — session body shape
  * /integration/integration-prompt — canonical end-to-end prompt\`\`\`\`
</pre>

Вставьте в

`vendor_data` — это идентификатор, который вы передаёте в каждой сессии и каждой транзакции, чтобы связать их с сущностью [User](https://docs.didit.me/ru/entities/users/overview.md) или [Business](https://docs.didit.me/ru/entities/businesses/overview.md). Это самое важное поле для агрегации сущностей: если оно задано правильно, все последующие функции (история профиля, мониторинг транзакций, применение списков блокировки, постоянный AML-мониторинг) работают без сбоев.

## Что это такое

`vendor_data` — это **строка**, которую выбираете вы. Didit рассматривает её как непрозрачный идентификатор и не интерпретирует её содержимое. Типичные значения:

| Ваша система | Подходящие значения `vendor_data` |
| - | - |
| Внутренняя база пользователей | `user_1234`, `uuid-v4` пользователя |
| Идентификатор для клиентов | `CUST-2026-00042`, хеш email |
| Мультитенантный SaaS | `tenant_acme:user_1234` |
| B2B-платформа | `company-hq-global`, `tax-id-US-123456789` |

> [!WARNING]
>
> **Не** передавайте персональные данные (email, номера телефонов, необработанные налоговые номера) в `vendor_data`. Хешируйте их или добавляйте префикс. `vendor_data` появляется в payload webhook-уведомлений и хранится бессрочно, пока существует сущность.

## Как это связывает данные

```mermaid theme={null}
flowchart TD
    subgraph YourSystem["Your system"]
      Customer["Customer record: user-42"]
    end
    subgraph Didit["Didit platform"]
      Entity["User entity (vendor_data = user-42)"]
      S1[Session #1]
      S2[Session #2]
      T1[Transaction #1]
      T2[Transaction #2]
      F[Face biometric]
    end
    Customer -.vendor_data.-> Entity
    S1 --> Entity
    S2 --> Entity
    T1 --> Entity
    T2 --> Entity
    F --> Entity
```

Когда вы отправляете сессию или транзакцию со значением `vendor_data`:

1. Didit ищет в вашем приложении сущность с этим `vendor_data`.
2. Если она существует, новый объект привязывается к этой сущности.
3. Если её нет, Didit создаёт сущность (со `status: ACTIVE`) и привязывает к ней новый объект.

Это относится к:

* `POST /v3/session/`: сессии KYC и верификации бизнеса (KYB)
* `POST /v3/transactions/`: транзакции (для заявителя и контрагента)
* Полям `applicant.vendor_data` и `counterparty.vendor_data` внутри payload транзакций

## Уникальность и область действия

`vendor_data` **уникален в пределах приложения**, а не во всём Didit:

| Область | Гарантия уникальности |
| - | - |
| В пределах одного приложения | `vendor_data` уникален для каждого типа сущности (User и Business — разные пространства имён) |
| В приложениях вашей организации | `vendor_data` **не используется совместно**: одно и то же значение в двух приложениях относится к двум разным сущностям |
| В разных организациях | Не используется совместно: у каждой организации собственные таблицы сущностей |

Это значит, что одно и то же `vendor_data` можно использовать в стейджинговом и в продакшн-приложении без конфликтов. Также можно иметь User `user-42` и Business `user-42` без конфликта, хотя для ясности это не рекомендуется.

## Что происходит, если не передать `vendor_data`

Сессию можно создать и без `vendor_data`. В этом случае:

* Для сессии сущность не создаётся.
* Сессия остаётся без привязки: она не появится ни в одном профиле User или Business.
* Позже найти сессию по `vendor_data` нельзя, только по `session_id`.

Используйте этот подход только для анонимных или разовых верификаций, где агрегация сущностей не нужна. Для любой интеграции, которая включает повторную верификацию, транзакции или постоянный мониторинг, всегда передавайте `vendor_data`.

## Пример: создание сущности заранее, затем запуск сессий

```bash theme={null}
# 1. Pre-create the User with initial metadata
curl -X POST https://verification.didit.me/v3/users/create/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data": "user-42",
    "display_name": "Jane Doe",
    "metadata": { "tier": "premium", "signup_date": "2026-04-01" }
  }'

# 2. Create a User Verification (KYC) session for the same user
curl -X POST https://verification.didit.me/v3/session/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_id": "wf_kyc_standard",
    "vendor_data": "user-42"
  }'

# 3. Later, submit a transaction tied to the same user
curl -X POST https://verification.didit.me/v3/transactions/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "txn_id": "tx-0001",
    "direction": "OUTBOUND",
    "amount": "500.00",
    "currency": "EUR",
    "applicant": { "vendor_data": "user-42" },
    "counterparty": { "name": "Acme Corp" }
  }'
```

Все три вызова привязаны к одной сущности User. Когда вы позже выполните `GET /v3/users/user-42/`, вы увидите количество сессий, счётчики одобренных и отклонённых верификаций, связанные транзакции и последние данные профиля.

## Миграция внешних идентификаторов

Если вы переходите на Didit с другого KYC-провайдера, передавайте существующие стабильные идентификаторы пользователей как `vendor_data` с первого дня. Так будет проще:

* Сверять данные Didit с вашей внутренней базой.
* Массово загрузить исторических пользователей через импорт CSV в консоли до запуска любых сессий.
* Сохранить связи, если позже вы перейдёте на Didit для мониторинга транзакций.

## Правила, соглашения и рекомендации

| Правило | Почему |
| - | - |
| Выберите один канонический идентификатор для каждой сущности и никогда его не меняйте | Изменение создаёт новую сущность и оставляет историю без связи |
| Добавляйте к значениям `vendor_data` префикс по типу сущности (`user_...`, `biz_...`) | Предотвращает случайные конфликты между пространствами имён в вашем коде |
| Сохраняйте регистр `vendor_data` неизменным | Didit не приводит регистр к единому виду |
| Длина `vendor_data` должна быть меньше 128 символов | Комфортно помещается в индексы базы данных |
| Никогда не раскрывайте персональные данные в открытом виде | `vendor_data` появляется в webhook, журналах аудита и ответах API |

## Что дальше

> [card] [Обзор Users](https://docs.didit.me/ru/entities/users/overview.md)
>
> Подробно о сущностях User и операциях с ними.

> [card] [Обзор Businesses](https://docs.didit.me/ru/entities/businesses/overview.md)
>
> Подробно о сущностях Business и операциях с ними.

> [card] [Создание сессии](https://docs.didit.me/ru/sessions-api/create-session.md)
>
> Запустите верификацию для vendor\_data.

> [card] [Создание транзакции](https://docs.didit.me/ru/management-api/transactions/create.md)
>
> Отправьте транзакцию, связанную с сущностью.


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