Перейти к основному содержанию
PATCH
cURL
Для частичного обновления используйте PATCH. Чтобы переименовать сценарий, отправьте только workflow_label.
Чтобы изменить проверки в сценарии, отправьте полный желаемый массив features. Он заменит текущий порядок функций и их конфигурацию.
API v3 поддерживает только простые сценарии: один линейный путь и один финальный шаг со статусом. Ветвление, узлы действий и узлы webhook здесь не принимаются.

Справочник по конфигурации функций

Когда вы отправляете features в PATCH, массив заменяет текущий порядок функций и их конфигурацию. Укажите заново все обязательные параметры конфигурации. Точный объект config зависит от функции. Полный список полей, значений по умолчанию, обязательных настроек, допустимых диапазонов и примеров см. в разделе Конфигурации функций сценария. Для OCR опустите config.documents_allowed, передайте null или {}, чтобы разрешить все поддерживаемые типы документов. Указывайте этот параметр, только если хотите ограничить сценарий определёнными странами или типами документов. Для QUESTIONNAIRE параметр config.questionnaire_uuid обязателен.

Обновление настроек сценария

Вы можете изменять настройки на уровне сессии, не затрагивая список функций. Отправляйте только те поля, которые хотите изменить.
Используйте uuid сценария, полученный из endpoint списка, создания или получения, как settings_uuid в этом URL.

Авторизации

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 конкретной версии обновляемого сценария.

Тело

application/json

Обновить метаданные сценария или заменить полный линейный список функций. СТРОГИЙ белый список полей: любой неуказанный здесь ключ отклоняется с ошибкой 400.

workflow_label
string

Отображаемое имя для сценария (максимум 50 символов).

Maximum string length: 50
is_default
boolean

Установить этот сценарий по умолчанию для новых сессий.

status
enum<string>

Управляет версионированием. Опустите, чтобы обновить текущую версию на месте (черновики публикуются автоматически). Значение published для уже опубликованной версии создаёт и возвращает НОВУЮ версию. Значение draft допустимо только тогда, когда версия всё ещё является черновиком.

Доступные опции:
draft,
published
features
object[]

Если указано, полностью заменяет порядок и конфигурацию функций.

Minimum array length: 1
is_white_label_enabled
boolean

Включить кастомизацию White label для сессий, созданных с этим сценарием.

is_desktop_allowed
boolean

Разрешить запуск сценария верификации в браузерах на десктопе.

max_retry_attempts
integer

Максимальное количество повторных попыток после отклонения верификации. 0 блокирует пользователя после первого отклонения.

Требуемый диапазон: 0 <= x <= 10
retry_window_days
integer | null

Скользящее окно в днях для подсчёта повторных попыток. null устанавливает лимит за всё время.

Требуемый диапазон: 1 <= x <= 365
face_liveness_max_attempts
integer

Максимальное количество попыток проверки живости за сессию. Это значение также копируется в сгенерированные узлы проверки живости и оценки возраста в сценарии, если только оно не переопределено в конфигурации на уровне функции.

Требуемый диапазон: 1 <= x <= 3
face_match_max_attempts
integer

Максимальное количество попыток сравнения лиц за сессию. Это значение также копируется в сгенерированные узлы сравнения лиц в сценарии, если только оно не переопределено в конфигурации на уровне функции.

Требуемый диапазон: 1 <= x <= 3
session_expiration_time
integer

Количество секунд до истечения срока незавершённой сессии. Минимум 1 час (3600), максимум 4 недели (2419200).

Требуемый диапазон: 3600 <= x <= 2419200

Ответ

Сценарий обновлён. Тело ответа представляет собой ПОЛНУЮ конфигурацию полученной версии (та же исходная структура VerificationSettings, что и в GET /v3/workflows/{settings_uuid}/). Если обновление создало новую версию (отправлено status: "published" для опубликованной строки), возвращённые uuid и version отличаются от тех, к которым вы применили патч — используйте возвращённый uuid для последующих вызовов.

Поля ниже являются типизированными; объект также содержит все остальные столбцы конфигурации сценария (переключатели функций, пороги, действия при предупреждениях, разрешённые документы, обратные вызовы) в качестве дополнительных свойств. Поля, неприменимые к 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 г.