> ## 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: получение через Management API Didit > Didit: получите настройки webhook приложения — URL и секрет, адреса назначения, события, хранение данных и хосты возврата для кошельков. Промпт API получения конфигурации webhook Скопировать промпт в буфер обмена \

\`Read my Didit application's webhook configuration through the Management API.

Endpoint:
GET https://verification.didit.me/v3/webhook/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs webhooks: read.

Goal:
\- Get every setting that controls how Didit sends webhooks for my application, plus the data-retention policy and the Digital ID wallet return hosts, in one call. Use it to audit the setup or to show the current configuration in a back office.

Behavior:
\- Didit delivers webhooks to webhook destinations (/v3/webhook/destinations/). Each destination has its own url, webhook_version, secret_shared_key and subscribed_events.
\- webhook_url, webhook_version and secret_shared_key at the top level are the application-level (legacy) webhook. Didit uses them only while the application has no enabled destination, and then only for status.updated and data.updated.
\- Every create, update or delete of a destination sets webhook_url to the URL of the oldest enabled destination, or null when none is enabled.
\- API-key callers always receive the application secret and every destination secret in full.

Example call:
curl -X GET "https://verification.didit.me/v3/webhook/" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- endpoints: every destination, oldest first, with uuid, label, url, enabled, webhook_version, secret_shared_key and subscribed_events. Verify each webhook with the secret of the destination it was sent to.
\- available_events: every event type you can subscribe a destination to ({ value, label }).
\- webhook_url, webhook_version, secret_shared_key: the legacy webhook, only relevant when no destination is enabled.
\- data_retention_months (null means no automatic deletion), face_retention_policy and face_retention_days: the retention policy.
\- allowed_return_hosts: hosts a Digital ID wallet verification may send the person back to.
\- allowed_domains: web origins the hosted verification flow may be embedded in and may send the user back to; empty means no restriction.
\- capture_method: MOBILE or MOBILE_AND_DESKTOP. A legacy setting with no effect; capture options are set per workflow.

Failure modes:
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." } for a missing key (a wrong, revoked or expired key gets 401); { "detail": "This API key has no read access to webhooks." } for a scoped key without webhooks: read.
\- 429: more than 600 GET requests per minute with this key; wait for Retry-After.

Side effects: none. This is a pure read, and the response contains signing secrets: never log it.

For the full integration shape, see /integration/integration-prompt.`

\
Вставьте в Этот endpoint возвращает webhook на уровне приложения, который существовал до появления адресов назначения, а также список адресов назначения. Didit доставляет webhook на ваши [адреса назначения webhook](https://docs.didit.me/ru/management-api/webhook/list-destinations.md), каждый из которых подписывается собственным `secret_shared_key`. Верхнеуровневые `webhook_url`, `webhook_version` и `secret_shared_key` используются только тогда, когда ни один адрес назначения не включён, и только для событий `status.updated` и `data.updated`.> [!WARNING] > > Ответ содержит все секреты для подписи вашего приложения. Не допускайте их попадания в логи и клиентский код.Чтобы изменить эти настройки, используйте [Обновление конфигурации webhook](https://docs.didit.me/ru/management-api/webhook/update-config.md). Сведения о проверке подписи и формате payload см. в [руководстве по webhook](https://docs.didit.me/ru/integration/webhooks.md). Поля хранения данных описаны в разделе [Хранение данных](https://docs.didit.me/ru/console/data-retention.md). ## OpenAPI ````yaml ru/openapi-25.json GET /v3/webhook/ 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/webhook/: get: tags: - Webhook summary: Получить конфигурацию webhook description: >- Возвращает настройки webhook приложения за один вызов: каждый [адрес назначения webhook](https://docs.didit.me/ru/management-api/webhook/list-destinations) с его секретом подписи, типы событий, на которые может подписаться адрес назначения, URL webhook уровня приложения (устаревший), версию и секрет, политику хранения данных и биометрических шаблонов, а также хосты возврата кошелька Digital ID. Didit доставляет события webhook на адреса назначения; каждое событие подписывается собственным `secret_shared_key`; поля верхнего уровня `webhook_url`, `webhook_version` и `secret_shared_key` используются только при отсутствии включённых адресов назначения и исключительно для `status.updated` и `data.updated`. Ответ содержит секреты подписи, поэтому не сохраняйте его в журналах и клиентском коде. Для API-ключа с ограниченным набором прав требуется `webhooks: read`. operationId: get_webhook_config parameters: [] responses: '200': description: Конфигурация webhook. content: application/json: schema: $ref: '#/components/schemas/WebhookConfig' examples: One destination: value: webhook_url: https://yourapp.com/webhooks/didit webhook_version: v3 secret_shared_key: dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA capture_method: MOBILE data_retention_months: 24 face_retention_policy: delete_with_session face_retention_days: null biometric_consent_mode: auto available_events: - value: status.updated label: Session status updated - value: data.updated label: Session data updated - value: user.status.updated label: User status updated - value: user.data.updated label: User data updated - value: business.status.updated label: Business status updated - value: business.data.updated label: Business data updated - value: activity.created label: Activity created - value: transaction.created label: Transaction created - value: transaction.status.updated label: Transaction status updated - value: travel_rule.status.updated label: Travel Rule Status Updated - value: workflow.compliance_changed label: Workflow Compliance Changed allowed_return_hosts: - shop.example.com endpoints: - uuid: 11111111-2222-3333-4444-555555555555 label: Production session webhooks url: https://yourapp.com/webhooks/didit enabled: true webhook_version: v3 secret_shared_key: dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA subscribed_events: - status.updated - data.updated created_at: '2026-01-04T08:00:00.000000Z' updated_at: '2026-04-22T14:09:11.523671Z' '401': description: >- Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`. content: application/json: schema: type: object properties: detail: type: string description: Понятное сообщение об ошибке. examples: Expired key: value: detail: This API key has expired. '403': description: >- Запрос не разрешён. Отсутствующий, недействительный или отозванный `x-api-key` возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.` content: application/json: schema: type: object properties: detail: type: string description: Понятное сообщение об ошибке. examples: Missing or invalid key: value: detail: You do not have permission to perform this action. Scoped key without webhooks read: value: detail: This API key has no read access to webhooks. Outside the IP allowlist: value: detail: This API key can't be used from this IP address. '429': description: >- Лимит запросов превышен: более 600 GET-запросов в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой. headers: Retry-After: description: Количество секунд ожидания перед повторной попыткой. schema: type: integer minimum: 1 example: 30 X-RateLimit-Limit: description: Количество разрешённых запросов в минутном окне (600). schema: type: integer example: 600 X-RateLimit-Remaining: description: Количество оставшихся запросов в текущем окне. schema: type: integer example: 0 X-RateLimit-Reset: description: Unix-время (в секундах), когда текущее окно сбрасывается. schema: type: integer example: 1792056120 X-RateLimit-Scope: description: Название бюджета, который был превышен. schema: type: string example: generic-get content: application/json: schema: type: object properties: detail: type: string description: Понятное сообщение об ошибке. examples: Throttled: value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X GET 'https://verification.didit.me/v3/webhook/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.webhooks.retrieve_config() 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.webhooks.retrieveConfig(); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.RetrieveConfig(ctx)\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.webhooks().retrieveConfig(); System.out.println(result); - lang: php label: PHP source: |- webhooks->retrieveConfig(); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.webhooks.retrieve_config 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.Webhooks.RetrieveConfigAsync(); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: WebhookConfig: type: object description: >- Конфигурация webhook уровня приложения, политика хранения данных и хосты возврата кошелька Digital ID вместе со всеми адресами назначения webhook. required: - webhook_url - webhook_version - secret_shared_key - capture_method - data_retention_months - face_retention_policy - face_retention_days - available_events - allowed_return_hosts - endpoints properties: webhook_url: type: string format: uri nullable: true description: >- URL webhook уровня приложения (устаревший). Didit отправляет на него запросы только до тех пор, пока у приложения нет включённого адреса назначения webhook, и только события `status.updated` и `data.updated`. Любое создание, обновление или удаление адреса назначения webhook устанавливает его в URL самого старого включённого адреса назначения webhook или в `null`, если ни один не включён. webhook_version: type: string enum: - v1 - v2 - v3 description: >- Версия payload устаревшего `webhook_url`. У каждого адреса назначения своя `webhook_version`. secret_shared_key: type: string description: >- Секрет подписи уровня приложения (43-символьный URL-безопасный токен). Он подписывает только доставку на устаревший `webhook_url`; каждый адрес назначения подписывает со своим `secret_shared_key`. При вызове с API-ключом он всегда возвращается полностью; пользователи консоли без разрешения `read:webhooks` получают пустую строку. capture_method: type: string enum: - MOBILE - MOBILE_AND_DESKTOP description: >- Устаревшая настройка приложения. Сценарий верификации её не считывает: параметры захвата настраиваются для каждого сценария отдельно. data_retention_months: type: integer nullable: true minimum: 1 maximum: 120 description: >- Окно автоматического удаления. Сессии проверки пользователей, созданные более указанного количества месяцев назад (месяц считается как 30 дней), удаляются автоматически, и это удаление необратимо. `null` означает, что сессии никогда не удаляются автоматически. См. раздел [Хранение данных](https://docs.didit.me/ru/console/data-retention). face_retention_policy: type: string enum: - delete_with_session - retain_until_user_deleted description: >- Что происходит с эмбеддингом лица сессии при удалении сессии. `delete_with_session` (по умолчанию) удаляет его вместе с сессией. `retain_until_user_deleted` представляет собой подключаемое [хранение биометрических шаблонов](https://docs.didit.me/ru/console/data-retention#хранение-биометрических-шаблонов): биометрический шаблон без изображения, привязанный к пользователю, администрируется отдельно до окончания срока его хранения, удаления пользователя или принудительной очистки вами. face_retention_days: type: integer nullable: true minimum: 1 maximum: 3650 description: >- Срок хранения биометрических шаблонов в днях согласно политике `retain_until_user_deleted`. Обязателен, если задана эта политика. biometric_consent_mode: type: string enum: - auto - always - never description: >- Когда размещённый сценарий и нативные SDK запрашивают у человека явное биометрическое согласие перед захватом лица. Значение `auto` (по умолчанию) запрашивает согласие только при срабатывании триггера: указанный штат, IP-адрес пользователя или эмитент документа, удостоверяющего личность, относятся к Иллинойсу, Техасу или Колорадо, либо пользователь предположительно находится в США без определённого штата. Значение `always` запрашивает согласие у каждого человека, чей сценарий включает захват лица. Значение `never` никогда не показывает этот шаг, и вы собираете согласие самостоятельно перед селфи. Каждое изменение фиксируется в журнале аудита. См. [Biometric consent](https://docs.didit.me/ru/getting-started/biometric-consent). available_events: type: array description: >- Каждый тип события, на который может подписаться адрес назначения, с отображаемой меткой. items: type: object required: - value - label properties: value: $ref: '#/components/schemas/WebhookEvent' label: type: string description: Отображаемая метка, например `Session status updated`. allowed_return_hosts: type: array maxItems: 20 description: >- Имена хостов (точное совпадение, только HTTPS), на которые автономная верификация кошелька Digital ID может вернуть пользователя через `return_url`. Ваш White label домен также всегда разрешён. См. [Зарегистрируйте адрес назначения для возврата](https://docs.didit.me/ru/standalone-apis/digital-id-wallets#регистрация-адреса-возврата). items: type: string maxLength: 253 endpoints: type: array description: >- Каждый адрес назначения webhook приложения, начиная с самых старых, каждый со своим секретом подписи. Здесь доступен только просмотр: управляйте адресами назначения с помощью endpoint `/v3/webhook/destinations/`. items: $ref: '#/components/schemas/WebhookConfigDestination' allowed_domains: type: array maxItems: 50 items: type: string maxLength: 300 description: >- Источники (origins, например `https://app.example.com`; `http` разрешен только для `localhost`), в которые может быть встроен размещенный сценарий верификации и куда пользователь может быть перенаправлен с помощью обратного вызова сессии. На вызовы между серверами ограничение не распространяется. Пустой список означает отсутствие ограничений. Didit сохраняет каждый origin в нижнем регистре без порта по умолчанию. Недопустимая запись приводит к ошибке `400` в `allowed_domains`. example: - https://app.example.com WebhookEvent: type: string description: >- Поддерживаемое имя события webhook. Используйте именно эти строки в `subscribed_events`; неподдерживаемые значения отклоняются. enum: - status.updated - data.updated - user.status.updated - user.data.updated - business.status.updated - business.data.updated - activity.created - transaction.created - transaction.status.updated - travel_rule.status.updated - workflow.compliance_changed - transaction_rule_suggestions.created - auth.signup - auth.login - auth.login_failed - auth.password_reset_requested - auth.password_reset_completed - auth.mfa_changed - auth.new_device - auth.account_locked - investigator.report.ready - investigator.decision.automated - investigator.decision.overridden - investigator.decision.contested - investigator.question.raised - investigator.automation.paused - investigator.rfi.answered - investigator.rfi.overdue - investigator.drift.detected - investigator.sla.breached - investigator.qa.failed - investigator.external.report.ready WebhookConfigDestination: type: object description: >- Адрес назначения webhook, указанный в конфигурации webhook, без метрик доставки. `GET /v3/webhook/destinations/{destination_uuid}/` добавляет сводку по доставке. required: - uuid - label - url - enabled - webhook_version - secret_shared_key - subscribed_events - created_at - updated_at properties: uuid: type: string format: uuid description: ID адреса назначения. label: type: string maxLength: 255 description: Понятное человеку имя. url: type: string format: uri maxLength: 2000 description: HTTPS-endpoint, на который Didit отправляет события. enabled: type: boolean description: '`false` приостанавливает доставки на этот адрес назначения.' webhook_version: type: string enum: - v1 - v2 - v3 description: Версия payload, отправляемая по этому адресу назначения. secret_shared_key: type: string description: >- Секрет подписи для этого адреса назначения (43-символьный URL-безопасный токен). Проверяйте каждый webhook с помощью секрета того адреса назначения, на который он был отправлен. Вызывающие с API-ключом всегда получают его полностью; пользователи Консоли без `read:webhooks` получают пустую строку. subscribed_events: type: array uniqueItems: true description: >- Типы событий, доставляемые на этот адрес назначения. Пусто, если адрес назначения был создан без событий; в таком случае он ничего не получает. items: $ref: '#/components/schemas/WebhookEvent' created_at: type: string format: date-time updated_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.