Перейти к основному содержанию
GET
cURL

Авторизации

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.

Параметры пути

settings_uuid
string<uuid>
обязательно

UUID конкретной версии сценария (значение uuid, возвращаемое endpoint списка). Каждая версия сценария имеет собственный settings_uuid.

Ответ

Полная конфигурация сценария. Формат представляет собой сырую сериализацию VerificationSettings (~190 полей: переключатель каждой функции, порог, действие при предупреждении, конфигурация разрешённых документов, workflow_graph, политика повторных попыток, обратные вызовы и цены). Пример ниже сокращён. Примечания: features представляет собой строку, разделённую " + " (например, "OCR + LIVENESS"), цены являются числами JSON, а is_editable имеет значение true только для версий draft.

Поля ниже являются типизированными; объект также содержит все остальные столбцы конфигурации сценария (переключатели функций, пороги, действия при предупреждениях, разрешённые документы, обратные вызовы) в качестве дополнительных свойств. Поля, неприменимые к workflow_type, имеют значение null.

uuid
string<uuid>

Идентификатор конкретной версии (settings_uuid). Каждая версия сценария имеет собственный идентификатор.

workflow_id
string<uuid>

Постоянный идентификатор, общий для всех версий сценария. Созданные с его помощью сессии используют последнюю опубликованную версию.

workflow_label
string

Отображаемое имя сценария.

workflow_type
enum<string> | null

Шаблон сценария. null для графовых сценариев, созданных без шаблона.

Доступные опции:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

Является ли этот сценарий сценарием по умолчанию для приложения.

is_archived
boolean

Архивные сценарии не могут запускать новые сессии.

version
integer

Номер версии внутри сценария.

status
enum<string>

Черновые версии можно редактировать; опубликованные версии неизменяемы и используются для новых сессий.

Доступные опции:
draft,
published
published_at
string<date-time> | null

Когда была опубликована эта версия. null для черновиков.

is_simple_workflow
boolean

true, если сценарий не имеет пользовательского workflow_graph.

is_editable
boolean

true только для версий со статусом draft.

workflow_url
string<uri>

Публичный URL для запуска сессии с этим сценарием.

workflow_graph
object | null

Структура графа сценария (узлы и рёбра). null для простых сценариев.

features
string

Включенные функции, объединенные через " + ", например "OCR + LIVENESS".

total_price
number | null

Цена за сессию; для графовых сценариев это самый дорогой путь.

min_price
number | null

Цена самого дешёвого пути в сценарии.

max_price
number | null

Цена самого дорогого пути в сценарии.

special_add_on_prices
object | null

Специальные цены на дополнения для организации или null, если они не заданы.

max_retry_attempts
integer

Количество повторных попыток, разрешенных после отклоненной верификации.

retry_window_days
integer | null

Количество дней, в течение которых разрешены повторные попытки.

session_expiration_time
integer

Количество секунд до истечения срока незавершённой сессии.

questionnaire
object | null

Анкета, прикрепленная к сценарию, или null.

kyb_role_settings
object[]

Настройки верификации по ролям для ключевых лиц KYB.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

Какие уровни Электронной подписи доступны для подписания прямо сейчас. Проверьте это перед установкой signature_level. Возвращается в сценариях kyc, kyb и графовых сценариях.

is_bank_verification_enabled
boolean

Выполняется ли в простом сценарии KYC или KYB верификация банка. Она выполняется после шагов контакта (и верификации местоположения) и перед проверкой по базам данных, AML и анализом IP. Верификация банка пока не является общедоступной: её включение отклоняется везде, где она не активирована.

bank_verification_config
object

Настройки верификации банковских счетов простого сценария с теми же ключами, которые принимает узел BANK_VERIFICATION (например, bank_countries и bank_method_order). Неизвестные ключи отбрасываются. Каждый ключ необязателен, а отсутствующий ключ сохраняет значение по умолчанию, поэтому {} означает использование всех значений по умолчанию. См. раздел Настройки верификации счетов.

Пример:
is_geolocation_enabled
boolean

Выполняется ли в простом сценарии KYC верификация местоположения. Она выполняется после шагов контакта и перед верификацией банка и проверкой по базам данных. В сценариях верификации бизнеса (KYB) этот шаг недоступен.

geolocation_config
object

Настройки верификации местоположения для простого сценария с теми же ключами, которые принимает узел GEOLOCATION (например, is_geolocation_geofencing_enabled и geolocation_max_attempts). Неизвестные ключи отбрасываются. Каждый ключ необязателен; отсутствующий ключ сохраняет значение по умолчанию, поэтому {} означает использование всех значений по умолчанию.

Пример:
Последнее изменение 7 ноября 2026 г.