> ## 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 в API

> Обновите webhook приложения в Didit: смените секрет, задайте хранение данных и биометрических шаблонов, добавьте хосты возврата для Digital ID.



Промпт API обновления конфигурации webhook
        Скопировать промпт в буфер обмена



      
      

\<pre>

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

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

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

Goal:
\- Change application-level settings: the legacy webhook URL and version, the application secret, the data-retention and biometric-template retention policy, the Digital ID wallet return hosts, or the allowed origins of the hosted flow.

Behavior:
\- Partial update: send only the fields to change. The response is the full configuration, the same shape as GET /v3/webhook/.
\- webhook_url and webhook_version change the application-level (legacy) webhook only. Didit uses it only while the application has no enabled destination, and only for status.updated and data.updated. It does not create a destination, and the next create, update or delete of a destination replaces webhook_url. To receive webhooks, create a destination with POST /v3/webhook/destinations/ instead.
\- rotate_secret_key: true replaces the application-level secret_shared_key immediately. Destination secrets are not changed. Each call generates a new secret, so it is not idempotent.
\- data_retention_months (1 to 120, or null for no automatic deletion): user verification sessions older than this many 30-day months are deleted automatically. Business verification sessions are not affected.
\- face_retention_policy (delete_with_session or retain_until_user_deleted) and face_retention_days (1 to 3650). retain_until_user_deleted needs face_retention_days in the same request or already set.
\- allowed_return_hosts replaces the registered list: up to 20 bare hostnames such as app.example.com (no scheme, port, path or wildcard). Send [] to clear it.
\- allowed_domains replaces the list of web origins (for example https://app.example.com; http only for localhost) that the hosted verification flow may be embedded in and may send the user back to with a session callback: up to 50 entries of at most 300 characters. Send [] to remove the restriction. Server-to-server calls are not affected. An invalid entry returns 400 on allowed_domains.
\- Manage destinations with the /v3/webhook/destinations/ endpoints, not here. Never send an endpoints field to this call: it is not part of this contract.

Example call:
curl -X PATCH "https://verification.didit.me/v3/webhook/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'

What to read from the response:
\- The updated fields, and secret_shared_key when you rotated it: store the new value before you discard the response.

Failure modes:
\- 400: field errors, each field mapped to a list of messages, for example { "face_retention_days": ["A finite retention duration is required when face retention is enabled."] }. Nothing is changed.
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." } or { "detail": "This API key has no write access to webhooks." }
\- 429: more than 300 write requests per minute with this key; wait for Retry-After.

Side effects:
\- Rotating the secret changes how deliveries to the legacy webhook_url are signed from then on, retries included.
\- A data_retention_months change applies to existing sessions too: every session older than the new window is deleted automatically, and that deletion is irreversible.
\- A face_retention_policy change applies to session deletions from then on; it creates or purges no existing biometric template.

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

\</pre>



      
      

Вставьте в

> [!NOTE]
>
> `rotate_secret_key` перевыпускает только секрет уровня приложения, которым подписываются доставки на устаревший `webhook_url`. Каждый [адрес назначения webhook](https://docs.didit.me/ru/management-api/webhook/list-destinations.md) подписывает доставки собственным `secret_shared_key`, и этот вызов его не меняет.Поля хранения данных соответствуют той же политике, которую вы задаёте в **Business Console → App Settings → Data retention**. Перед их изменением прочитайте [Хранение данных](https://docs.didit.me/ru/console/data-retention.md), в особенности [хранение биометрических шаблонов](https://docs.didit.me/ru/console/data-retention.md#хранение-биометрических-шаблонов). `allowed_return_hosts` описан в разделе [Регистрация адреса возврата](https://docs.didit.me/ru/standalone-apis/digital-id-wallets.md#регистрация-адреса-возврата).`biometric_consent_mode` (`auto`, `always` или `never`) определяет, когда сценарий верификации запрашивает явное биометрическое согласие перед захватом лица. См. [Биометрическое согласие](https://docs.didit.me/ru/getting-started/biometric-consent.md).Чтобы сначала прочитать текущие значения, вызовите [Получить конфигурацию webhook](https://docs.didit.me/ru/management-api/webhook/get-config.md).


## OpenAPI

````yaml ru/openapi-25.json PATCH /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/:
    patch:
      tags:
        - Webhook
      summary: Обновить конфигурацию webhook
      description: >-
        Частично обновить настройки уровня приложения: устаревший URL webhook,
        версию и секрет, политику хранения данных и биометрических шаблонов, а
        также хосты возврата кошелька Digital ID. Передавайте только поля,
        которые необходимо изменить; в ответе возвращается полная конфигурация
        того же формата, что и в `GET /v3/webhook/`. Адреса назначения здесь не
        настраиваются: создавайте, обновляйте и удаляйте их через endpoint'ы
        `/v3/webhook/destinations/` и не отправляйте поле `endpoints` в этот
        endpoint. Изменение `data_retention_months` также применяется к
        существующим сессиям, а удаленные сессии восстановить невозможно;
        сначала ознакомьтесь с разделом [Хранение
        данных](https://docs.didit.me/ru/console/data-retention). Для API-ключа
        с ограниченными правами требуется `webhooks: write`.
      operationId: update_webhook_config
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Отправляйте только те поля, которые нужно изменить. Адреса
                назначения здесь не настраиваются.
              properties:
                webhook_url:
                  type: string
                  format: uri
                  nullable: true
                  maxLength: 2000
                  description: >-
                    Устаревший URL webhook на уровне приложения. Didit
                    использует его только тогда, когда у приложения нет
                    включённого адреса назначения, и только для `status.updated`
                    и `data.updated`. Он не создаёт адрес назначения, и
                    следующее создание, обновление или удаление адреса
                    назначения заменяет его. Чтобы получать webhook, создайте
                    адрес назначения с помощью `POST /v3/webhook/destinations/`
                    вместо этого.
                webhook_version:
                  type: string
                  enum:
                    - v1
                    - v2
                    - v3
                  description: Версия payload устаревшего `webhook_url`.
                rotate_secret_key:
                  type: boolean
                  default: false
                  description: >-
                    `true` немедленно заменяет `secret_shared_key` на уровне
                    приложения новым случайным значением; новое значение
                    возвращается в ответе. Секреты адресов назначения не
                    изменяются. Каждый вызов с `true` генерирует новый секрет,
                    поэтому операция не является идемпотентной.
                capture_method:
                  type: string
                  enum:
                    - MOBILE
                    - MOBILE_AND_DESKTOP
                  description: >-
                    Устаревшая настройка приложения. Сценарий верификации её не
                    считывает.
                data_retention_months:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 120
                  description: >-
                    Окно автоматического удаления в месяцах (месяц считается как
                    30 дней) или `null` для отключения автоматического удаления.
                    Изменение применяется и к существующим сессиям: каждая
                    сессия проверки пользователей старше нового окна удаляется
                    автоматически, и это удаление необратимо.
                face_retention_policy:
                  type: string
                  enum:
                    - delete_with_session
                    - retain_until_user_deleted
                  description: >-
                    Что происходит с эмбеддингом лица сессии при удалении
                    сессии. Для `retain_until_user_deleted` требуется параметр
                    `face_retention_days` в том же запросе или уже установленный
                    ранее. Изменение применяется ко всем последующим удалениям
                    сессий; оно не создаёт и не удаляет существующие
                    биометрические шаблоны.
                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).
                allowed_return_hosts:
                  type: array
                  maxItems: 20
                  description: >-
                    Заменяет весь список хостов возврата кошелька Digital ID.
                    Только «чистые» имена хостов, например `shop.example.com`:
                    без схемы, порта, пути или масок (wildcard). Значения
                    приводятся к нижнему регистру, а дубликаты удаляются.
                    Отправьте `[]`, чтобы очистить список.
                  items:
                    type: string
                    maxLength: 253
                allowed_domains:
                  type: array
                  maxItems: 50
                  items:
                    type: string
                    maxLength: 300
                  description: >-
                    Заменяет весь список разрешённых источников. Источники
                    (например, `https://app.example.com`; `http` только для
                    `localhost`), в которые может быть встроен размещённый
                    сценарий верификации и на которые он может вернуть
                    пользователя через callback сессии. Межсерверные вызовы не
                    затрагиваются. Пустой список означает отсутствие
                    ограничений. Didit сохраняет каждый источник в нижнем
                    регистре без порта по умолчанию. Некорректная запись
                    завершается ошибкой `400` для `allowed_domains`. Отправьте
                    `[]`, чтобы снять ограничение.
                  example:
                    - https://app.example.com
            examples:
              Enable biometric template retention:
                value:
                  face_retention_policy: retain_until_user_deleted
                  face_retention_days: 365
                  biometric_consent_mode: auto
              Rotate the legacy secret:
                value:
                  rotate_secret_key: true
              Set data retention:
                value:
                  data_retention_months: 24
              Register return hosts:
                value:
                  allowed_return_hosts:
                    - shop.example.com
                    - app.example.com
      responses:
        '200':
          description: >-
            Полная конфигурация после обновления в том же формате, что и в `GET
            /v3/webhook/`. Если вы выполнили ротацию секрета, сохраните новый
            `secret_shared_key`, прежде чем отбросить ответ.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfig'
              examples:
                Retention enabled:
                  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: retain_until_user_deleted
                    face_retention_days: 365
                    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'
        '400':
          description: >-
            Ошибка валидации: каждое некорректное поле сопоставляется со списком
            сообщений, и ничего не изменяется. Тело запроса, не являющееся
            валидным JSON, возвращает `{"detail": "JSON parse error - ..."}`.
          content:
            application/json:
              schema:
                type: object
                description: Каждое некорректное поле, сопоставленное со списком сообщений.
                additionalProperties:
                  type: array
                  items:
                    type: string
              examples:
                Retention days missing:
                  value:
                    face_retention_days:
                      - >-
                        A finite retention duration is required when face
                        retention is enabled.
                    biometric_consent_mode: auto
                Retention window out of range:
                  value:
                    data_retention_months:
                      - Ensure this value is less than or equal to 120.
                Invalid return host:
                  value:
                    allowed_return_hosts:
                      - >-
                        'https://shop.example.com' is not a hostname. Register
                        the bare host (e.g. shop.example.com): no scheme, port,
                        path or wildcard.
                Invalid choice:
                  value:
                    face_retention_policy:
                      - '"forever" is not a valid choice.'
        '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 write:
                  value:
                    detail: This API key has no write access to webhooks.
                Outside the IP allowlist:
                  value:
                    detail: This API key can't be used from this IP address.
        '429':
          description: >-
            Лимит запросов превышен: более 300 запросов на запись (POST, PATCH,
            PUT, DELETE) в текущем минутном окне для этого API-ключа. Подождите
            `Retry-After` секунд перед повторной попыткой.
          headers:
            Retry-After:
              description: Количество секунд ожидания перед повторной попыткой.
              schema:
                type: integer
                minimum: 1
                example: 30
            X-RateLimit-Limit:
              description: Количество разрешённых запросов в минутном окне (300).
              schema:
                type: integer
                example: 300
            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-write
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Понятное сообщение об ошибке.
              examples:
                Throttled:
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.webhooks.update_config(
                face_retention_policy="retain_until_user_deleted",
                face_retention_days=365,
                biometric_consent_mode="auto",
            )
            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.updateConfig({
              face_retention_policy: "retain_until_user_deleted",
              face_retention_days: 365,
              biometric_consent_mode: "auto",
            });
            console.log(result);
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.WebhooksUpdateConfigParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
                    .faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
                    .faceRetentionDays(365L)
                    .biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->webhooks->updateConfig([
                'face_retention_policy' => 'retain_until_user_deleted',
                'face_retention_days' => 365,
                'biometric_consent_mode' => 'auto',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.webhooks.update_config(
              face_retention_policy: "retain_until_user_deleted",
              face_retention_days: 365,
              biometric_consent_mode: "auto"
            )
            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.UpdateConfigAsync(new
            WebhooksUpdateConfigParams

            {
                FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
                FaceRetentionDays = 365,
                BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
            });

            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.