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

# Вебхуки сущностей: события пользователей и компаний

> Webhook-уведомления Didit об изменениях User и Business: переходы статусов, обновления профиля, поля payload, подпись и повторные попытки.



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



      
      

\<pre>

\````# Goal — subscribe to entity-level webhooks and apply changes to my database

Entity webhooks fire whenever a User or Business entity changes its status or its profile data. Use them to keep your local mirror of Didit entities in sync.

\## Entity-level event catalog

\| `webhook_type` | Trigger |
\|---|---|
\| `user.status.updated` | User entity status changed (`ACTIVE` / `FLAGGED` / `BLOCKED`). Payload includes `previous_status`. |
\| `user.data.updated` | User entity profile / counters / metadata changed. Includes `changed_fields` and a `changes` map of `{previous, current}`. |
\| `business.status.updated` | Business entity status changed. Payload includes `previous_status`. |
\| `business.data.updated` | Business entity profile or aggregates changed. Includes `changed_fields` and `changes`. |

\`activity.created` is accepted in `subscribed_events` and by the Try Webhook tester, but Didit does not deliver it for live traffic. Do not build on it.

Session-level events (`status.updated`, `data.updated`) and transaction events (`transaction.created`, `transaction.status.updated`) live alongside but are separate — see /integration/webhooks for the full catalog.

\## Register a destination

\```bash
curl -X POST https://verification.didit.me/v3/webhook/destinations/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"label": "Entity sync",
"url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"subscribed_events": [
  "user.status.updated",
  "user.data.updated",
  "business.status.updated",
  "business.data.updated"
]
}'
\```

Persist the returned destination `secret_shared_key` — that's the HMAC signing key.

\## Payload shape

Entity payloads are flat: there is no `data` wrapper and no `event` key. Read `webhook_type`.

\```json
\{
"event_id": "7f3c2c1e-6a1d-4c36-9d8e-0d3b5f4e2a10",
"webhook_type": "user.status.updated",
"timestamp": 1776333600,
"created_at": 1776333594,
"application_id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"environment": "live",
"vendor_user_id": "9c7d2a30-...",
"vendor_data": "user-42",
"status": "BLOCKED",
"previous_status": "ACTIVE"
}
\```

\`business.*` events use `vendor_business_id` instead of `vendor_user_id`.
\`user.data.updated` / `business.data.updated` payloads keep `status` and add `changed_fields` (array) and `changes` (`{field: {previous, current}}`). Use these to apply minimal diffs to your DB.

\## Verify the signature

Verify X-Signature-V2 (recommended): HMAC-SHA256 of the canonical JSON body with the destination `secret_shared_key`, then a constant-time compare, and reject an X-Timestamp older than 300 seconds. See /integration/webhooks for the signature headers and code samples. Respond `2xx` within **5 seconds**. On a 5xx, 404, timeout or connection failure Didit retries up to 2 times (about 1 minute, then about 4 minutes later); see /integration/webhooks#retry-policy.

\## Idempotency

Every delivery carries a unique `event_id`. De-dupe on it. Fallback compound key: `(application_id, webhook_type, vendor_data, timestamp)`.

\## Failure modes

\- Wrong `webhook_version` (e.g. v2) → singular fields and older event names; v3 is required for entity events plural-array contract.
\- Slow handler → retried; budget < 5s; do heavy work async.
\- Unknown event type → log and 200; new event types may be added.

\## Apply-decision pseudocode

\```ts
switch (event.webhook_type) {
case "user.status.updated":
await db.users.update({ vendor_data: event.vendor_data }, { status: event.status });
break;
case "user.data.updated":
for (const field of event.changed_fields) {
  await db.users.update({ vendor_data: event.vendor_data }, { [field]: event.changes[field].current });
}
break;
case "business.status.updated":
case "business.data.updated": /* same shape, businesses table, keyed by vendor_business_id */ break;
}
\```

\## Sources of truth

\- /integration/webhooks — destinations, signatures, retries, full event catalog
\- /management-api/webhook/create-destination — endpoint schema
\- /entities/users/operations — operations that emit user events
\- /entities/businesses/operations — operations that emit business events
\- /integration/integration-prompt — canonical end-to-end prompt````

\</pre>



      
      

Вставьте в

Каждое изменение статуса или данных профиля сущности User или Business отправляет webhook, чтобы ваша система могла реагировать в реальном времени.
Используйте webhooks сущностей, чтобы синхронизировать данные профиля, передавать блокировки в другие системы или запускать последующие комплаенс-процессы.## Каталог событий| Событие | Триггер |
| - | - |
| `user.status.updated` | Статус сущности User меняется (`ACTIVE` ↔ `FLAGGED` ↔ `BLOCKED`) |
| `user.data.updated` | Поля профиля сущности User меняются (имя, дата рождения, портрет, совокупные счётчики, метаданные) |
| `business.status.updated` | Статус сущности Business меняется |
| `business.data.updated` | Поля профиля сущности Business меняются (юридическое название, регистрационный номер, страна, счётчики) |> [!NOTE]
>
> `activity.created` принимается в `subscribed_events` и покрывается тестером **Try Webhook**, но Didit в настоящее время не отправляет его для боевого трафика.
> Не строите на нём зеркалирование временной шкалы.Didit также отправляет события сессий, транзакций и бизнес-сессий, которые ссылаются на поля сущностей. См.:- [Webhooks KYB](https://docs.didit.me/ru/business-verification/webhooks.md): события бизнес-сессий
- [Webhooks Transaction Monitoring](https://docs.didit.me/ru/transaction-monitoring/webhooks.md): события транзакций
- [Справочник по webhooks](https://docs.didit.me/ru/integration/webhooks.md): проверка подписи, повторные попытки, адреса назначения## Структура payloadPayload webhooks сущностей плоский: нет обёртки `data` и нет ключа `event`.
Для маршрутизации события читайте `webhook_type`.```json theme={null}
{
  "event_id": "7f3c2c1e-6a1d-4c36-9d8e-0d3b5f4e2a10",
  "webhook_type": "user.status.updated",
  "timestamp": 1776333600,
  "created_at": 1776333594,
  "application_id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "environment": "live",
  "vendor_user_id": "9c7d2a30-2f98-4d4f-9d2d-1a7c4b1e5b6a",
  "vendor_data": "user-42",
  "status": "BLOCKED",
  "previous_status": "ACTIVE"
}
```| Поле | Описание |
| - | - |
| `vendor_user_id` / `vendor_business_id` | Идентификатор сущности в Didit. События `business.*` используют `vendor_business_id`. |
| `vendor_data` | Ваш идентификатор сущности. |
| `status` | `ACTIVE`, `FLAGGED` или `BLOCKED`. |
| `previous_status` | Только в `*.status.updated`. |
| `changed_fields` и `changes` | Только в `*.data.updated`. |
| `created_at` | Время последнего обновления сущности в секундах Unix. |
| `timestamp` | Время отправки webhook компанией Didit в секундах Unix. |### `user.status.updated` / `business.status.updated`Срабатывает при каждом изменении статуса.
Payload содержит `status` и `previous_status`.
Причина изменения статуса в нём не указана: если она нужна, откройте сущность в консоли.### `user.data.updated` / `business.data.updated`Срабатывает при изменении полей профиля.
`changed_fields` перечисляет изменившиеся поля, а `changes` содержит значения `previous` и `current` для каждого из них.```json theme={null}
{
  "event_id": "5d1e8f9a-0c32-4b6a-a7b6-2b9d6f0a3c41",
  "webhook_type": "user.data.updated",
  "timestamp": 1776333700,
  "created_at": 1776333694,
  "application_id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "environment": "live",
  "vendor_user_id": "9c7d2a30-2f98-4d4f-9d2d-1a7c4b1e5b6a",
  "vendor_data": "user-42",
  "status": "ACTIVE",
  "changed_fields": ["full_name", "session_count"],
  "changes": {
    "full_name": { "previous": null, "current": "John Doe" },
    "session_count": { "previous": 2, "current": 3 }
  }
}
```Поля, которые могут появиться в `changed_fields`:- User: `vendor_data`, `display_name`, `full_name`, `date_of_birth`, `metadata`, `portrait_image`, `issuing_states`, `approved_emails`, `approved_phones`, `features`, `session_count`, `approved_count`, `declined_count`, `in_review_count`, `first_session_at`, `last_session_at`.
- Business: `vendor_data`, `display_name`, `metadata`, `legal_name`, `registration_number`, `country_code`, `session_count`, `approved_count`, `declined_count`, `in_review_count`, `features`, `first_session_at`, `last_session_at`.Используйте `changed_fields` и `changes`, чтобы синхронизировать только изменившиеся поля.## Доставка, повторные попытки и подписьВсе webhooks сущностей следуют стандартному контракту доставки:- **Подписан** с помощью HMAC-SHA256 в заголовке `X-Signature-V2` (рекомендуется), с использованием `secret_shared_key` адреса назначения. Также отправляются `X-Signature` и устаревший `X-Signature-Simple`, а также `X-Timestamp`.
- **Повторяется** до 2 раз, примерно через 1 минуту и примерно через 4 минуты, если ваш endpoint отвечает кодом 5xx или 404, не отвечает по таймауту или не удаётся установить соединение. В [справочнике по webhooks](https://docs.didit.me/ru/integration/webhooks.md#политика-повторных-попыток) приведена полная политика.
- **Идемпотентный**: каждый webhook содержит уникальный `event_id` в payload; удаляйте дубликаты на своей стороне.См. [Справочник по webhooks](https://docs.didit.me/ru/integration/webhooks.md) для настройки адреса назначения и примеров кода проверки подписи.## ПодпискаПодписывайтесь на события сущностей для адреса назначения webhook через Management API или Business Console:```bash theme={null}
curl -X POST https://verification.didit.me/v3/webhook/destinations/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Entity sync",
    "url": "https://yourapp.com/webhooks/didit",
    "subscribed_events": [
      "user.status.updated",
      "user.data.updated",
      "business.status.updated",
      "business.data.updated"
    ]
  }'
```## Следующие шаги> [card] [Справочник по webhooks](https://docs.didit.me/ru/integration/webhooks.md)
>
> Адреса назначения, подписи, повторные попытки и проверка.> [card] [Создание адреса назначения](https://docs.didit.me/ru/management-api/webhook/create-destination.md)
>
> Регистрация нового endpoint для webhook.> [card] [Операции с пользователями](https://docs.didit.me/ru/entities/users/operations.md)
>
> Изменения, которые запускают webhooks пользователей.


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