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

Каждое изменение статуса или данных профиля сущности User или Business отправляет webhook, чтобы ваша система могла реагировать в реальном времени. Используйте webhooks сущностей, чтобы синхронизировать данные профиля, передавать блокировки в другие системы или запускать последующие комплаенс-процессы.

Каталог событий

Событие	Триггер
`user.status.updated`	Статус сущности User меняется (`ACTIVE` ↔ `FLAGGED` ↔ `BLOCKED`)
`user.data.updated`	Поля профиля сущности User меняются (имя, дата рождения, портрет, совокупные счётчики, метаданные)
`business.status.updated`	Статус сущности Business меняется
`business.data.updated`	Поля профиля сущности Business меняются (юридическое название, регистрационный номер, страна, счётчики)

activity.created принимается в subscribed_events и покрывается тестером Try Webhook, но Didit в настоящее время не отправляет его для боевого трафика. Не строите на нём зеркалирование временной шкалы.

Didit также отправляет события сессий, транзакций и бизнес-сессий, которые ссылаются на поля сущностей. См.:

Webhooks KYB: события бизнес-сессий
Webhooks Transaction Monitoring: события транзакций
Справочник по webhooks: проверка подписи, повторные попытки, адреса назначения

Структура payload

Payload webhooks сущностей плоский: нет обёртки data и нет ключа event. Для маршрутизации события читайте webhook_type.

{
  "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 для каждого из них.

{
  "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 приведена полная политика.
Идемпотентный: каждый webhook содержит уникальный event_id в payload; удаляйте дубликаты на своей стороне.

См. Справочник по webhooks для настройки адреса назначения и примеров кода проверки подписи.

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"
    ]
  }'

Следующие шаги

Справочник по webhooks

Адреса назначения, подписи, повторные попытки и проверка.

Создание адреса назначения

Регистрация нового endpoint для webhook.

Операции с пользователями

Изменения, которые запускают webhooks пользователей.

Обзор

Цены

Сценарии и верификация

Проверка и операции

Сущности (пользователи и компании)

Настройки и кастомизация

Безопасность и комплаенс

Didit Academy

Ресурсы

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

Каталог событий

Структура payload

`user.status.updated` / `business.status.updated`

`user.data.updated` / `business.data.updated`

Доставка, повторные попытки и подпись

Подписка

Следующие шаги

Справочник по webhooks

Создание адреса назначения

Операции с пользователями

​Каталог событий

​Структура payload

​user.status.updated / business.status.updated

​user.data.updated / business.data.updated

​Доставка, повторные попытки и подпись

​Подписка

​Следующие шаги

Справочник по webhooks

Создание адреса назначения

Операции с пользователями

Каталог событий

Структура payload

`user.status.updated` / `business.status.updated`

`user.data.updated` / `business.data.updated`

Доставка, повторные попытки и подпись

Подписка

Следующие шаги