Перейти к основному содержанию
GET
curl
Этот endpoint возвращает webhook на уровне приложения, который существовал до появления адресов назначения, а также список адресов назначения. Didit доставляет webhook на ваши адреса назначения webhook, каждый из которых подписывается собственным secret_shared_key. Верхнеуровневые webhook_url, webhook_version и secret_shared_key используются только тогда, когда ни один адрес назначения не включён, и только для событий status.updated и data.updated.
Ответ содержит все секреты для подписи вашего приложения. Не допускайте их попадания в логи и клиентский код.
Чтобы изменить эти настройки, используйте Обновление конфигурации webhook. Сведения о проверке подписи и формате payload см. в руководстве по webhook. Поля хранения данных описаны в разделе Хранение данных.

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Ответ

Конфигурация webhook.

Конфигурация webhook уровня приложения, политика хранения данных и хосты возврата кошелька Digital ID вместе со всеми адресами назначения webhook.

webhook_url
string<uri> | null
обязательно

URL webhook уровня приложения (устаревший). Didit отправляет на него запросы только до тех пор, пока у приложения нет включённого адреса назначения webhook, и только события status.updated и data.updated. Любое создание, обновление или удаление адреса назначения webhook устанавливает его в URL самого старого включённого адреса назначения webhook или в null, если ни один не включён.

webhook_version
enum<string>
обязательно

Версия payload устаревшего webhook_url. У каждого адреса назначения своя webhook_version.

Доступные опции:
v1,
v2,
v3
secret_shared_key
string
обязательно

Секрет подписи уровня приложения (43-символьный URL-безопасный токен). Он подписывает только доставку на устаревший webhook_url; каждый адрес назначения подписывает со своим secret_shared_key. При вызове с API-ключом он всегда возвращается полностью; пользователи консоли без разрешения read:webhooks получают пустую строку.

capture_method
enum<string>
обязательно

Устаревшая настройка приложения. Сценарий верификации её не считывает: параметры захвата настраиваются для каждого сценария отдельно.

Доступные опции:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null
обязательно

Окно автоматического удаления. Сессии проверки пользователей, созданные более указанного количества месяцев назад (месяц считается как 30 дней), удаляются автоматически, и это удаление необратимо. null означает, что сессии никогда не удаляются автоматически. См. раздел Хранение данных.

Требуемый диапазон: 1 <= x <= 120
face_retention_policy
enum<string>
обязательно

Что происходит с эмбеддингом лица сессии при удалении сессии. delete_with_session (по умолчанию) удаляет его вместе с сессией. retain_until_user_deleted представляет собой подключаемое хранение биометрических шаблонов: биометрический шаблон без изображения, привязанный к пользователю, администрируется отдельно до окончания срока его хранения, удаления пользователя или принудительной очистки вами.

Доступные опции:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null
обязательно

Срок хранения биометрических шаблонов в днях согласно политике retain_until_user_deleted. Обязателен, если задана эта политика.

Требуемый диапазон: 1 <= x <= 3650
available_events
object[]
обязательно

Каждый тип события, на который может подписаться адрес назначения, с отображаемой меткой.

allowed_return_hosts
string[]
обязательно

Имена хостов (точное совпадение, только HTTPS), на которые автономная верификация кошелька Digital ID может вернуть пользователя через return_url. Ваш White label домен также всегда разрешён. См. Зарегистрируйте адрес назначения для возврата.

Maximum array length: 20
Maximum string length: 253
endpoints
object[]
обязательно

Каждый адрес назначения webhook приложения, начиная с самых старых, каждый со своим секретом подписи. Здесь доступен только просмотр: управляйте адресами назначения с помощью endpoint /v3/webhook/destinations/.

Когда размещённый сценарий и нативные SDK запрашивают у человека явное биометрическое согласие перед захватом лица. Значение auto (по умолчанию) запрашивает согласие только при срабатывании триггера: указанный штат, IP-адрес пользователя или эмитент документа, удостоверяющего личность, относятся к Иллинойсу, Техасу или Колорадо, либо пользователь предположительно находится в США без определённого штата. Значение always запрашивает согласие у каждого человека, чей сценарий включает захват лица. Значение never никогда не показывает этот шаг, и вы собираете согласие самостоятельно перед селфи. Каждое изменение фиксируется в журнале аудита. См. Biometric consent.

Доступные опции:
auto,
always,
never
allowed_domains
string[]

Источники (origins, например https://app.example.com; http разрешен только для localhost), в которые может быть встроен размещенный сценарий верификации и куда пользователь может быть перенаправлен с помощью обратного вызова сессии. На вызовы между серверами ограничение не распространяется. Пустой список означает отсутствие ограничений. Didit сохраняет каждый origin в нижнем регистре без порта по умолчанию. Недопустимая запись приводит к ошибке 400 в allowed_domains.

Maximum array length: 50
Maximum string length: 300
Пример:
Последнее изменение 7 ноября 2026 г.