> ## 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. # Получение сценария через API: просмотр KYC-сценария > Получите полную конфигурацию KYC- или KYB-сценария Didit, включая переключатели функций, пороги и допустимые документы. Оплата за использование. Промпт для API получения сценария Скопировать промпт в буфер обмена \

\`Fetch the full configuration of a single Didit workflow through the Management API.

Endpoint:
GET https://verification.didit.me/v3/workflows/{settings_uuid}/

Authentication:
Use the x-api-key header with my Didit API key.

Goal:
\- Retrieve every editable field on the workflow (feature toggles, score thresholds, documents_allowed per country, KYB role config, retry policy, callback config, etc.).
\- Useful for back-office "view workflow" screens, debugging why a verification declined/routed to review, or verifying a freshly published version.

Path parameter:
\- settings_uuid — the per-version workflow UUID returned by GET /v3/workflows/ or POST /v3/workflows/. Each workflow version has its own settings_uuid; workflow_id is the stable group id shared by every version.

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

What to read from the response:
\- workflow_id — stable group id; compare across versions to walk version history.
\- features and the underlying workflow_graph — describes which checks run and in what order.
\- Threshold and action fields per feature — see /management-api/workflows/feature-configs for the full reference.

Failure modes:
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope when the workflow belongs to a different application than the API key.
\- 404 — workflow not found in this application (also returned when settings_uuid is valid in another application).

Side effects: none. This is a pure read.

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

\
Вставьте в ## OpenAPI ````yaml ru/openapi-25.json GET /v3/workflows/{settings_uuid}/ 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/workflows/{settings_uuid}/: get: tags: - Workflows summary: Получить сценарий description: >- Получить полную конфигурацию для одной версии сценария по `settings_uuid`: переключатели функций, пороги, разрешённые документы, граф, политика повторных попыток, обратные вызовы и цены. operationId: get_workflow parameters: - name: settings_uuid in: path required: true schema: type: string format: uuid description: >- UUID конкретной версии сценария (значение `uuid`, возвращаемое endpoint списка). Каждая версия сценария имеет собственный `settings_uuid`. responses: '200': description: >- Полная конфигурация сценария. Формат представляет собой сырую сериализацию `VerificationSettings` (~190 полей: переключатель каждой функции, порог, действие при предупреждении, конфигурация разрешённых документов, `workflow_graph`, политика повторных попыток, обратные вызовы и цены). Пример ниже сокращён. Примечания: `features` представляет собой строку, разделённую `" + "` (например, `"OCR + LIVENESS"`), цены являются числами JSON, а `is_editable` имеет значение `true` только для версий `draft`. content: application/json: schema: $ref: '#/components/schemas/WorkflowDetail' examples: KYC workflow with face match (abbreviated): value: uuid: a1b2c3d4-5678-90ab-cdef-111111111111 workflow_id: a1b2c3d4-5678-90ab-cdef-111111111111 workflow_label: Standard KYC workflow_type: kyc is_default: true is_archived: false is_liveness_enabled: true face_liveness_method: passive face_liveness_score_decline_threshold: 50 face_liveness_score_review_threshold: 70 is_face_match_enabled: true face_match_score_decline_threshold: 40 face_match_score_review_threshold: 60 is_aml_enabled: false is_phone_verification_enabled: false is_email_verification_enabled: false is_database_validation_enabled: false is_ip_analysis_enabled: false is_nfc_enabled: false duplicated_user_action: no_action documents_allowed: ESP: P: sides: 1 enabled: 1 subtypes: - EPASSPORT - PASSPORT_GENERIC preferred_characters: latin expiration_check_mode: strict max_retry_attempts: 3 retry_window_days: 7 session_expiration_time: 604800 version: 2 status: published published_at: '2026-04-12T10:30:00Z' is_simple_workflow: false is_editable: false workflow_url: https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ total_price: 0.15 min_price: 0.15 max_price: 0.15 features: OCR + LIVENESS + FACE_MATCH created_at: '2025-01-15T10:30:00Z' updated_at: '2026-04-12T10:30:00Z' '403': description: >- API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. content: application/json: examples: Invalid token: value: detail: You do not have permission to perform this action. '404': description: >- Сценарий с таким `settings_uuid` не существует для аутентифицированного приложения. Либо UUID неверен, либо он принадлежит другому приложению — Didit намеренно не разделяет эти два случая во избежание утечки информации о существовании записей других приложений. content: application/json: examples: Not found: value: detail: Not found. '429': description: >- Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой. '500': description: Непредвиденная ошибка сервера. Повторная попытка безопасна. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: cURL source: >- curl -X GET 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.workflows.retrieve( "11111111-2222-3333-4444-555555555555", ) 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.workflows.retrieve("11111111-2222-3333-4444-555555555555"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\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.workflows().retrieve("11111111-2222-3333-4444-555555555555"); System.out.println(result); - lang: php label: PHP source: >- workflows->retrieve('11111111-2222-3333-4444-555555555555'); print_r($result->toArray()); - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.workflows.retrieve("11111111-2222-3333-4444-555555555555") 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.Workflows.RetrieveAsync("11111111-2222-3333-4444-555555555555"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: WorkflowDetail: type: object description: >- Поля ниже являются типизированными; объект также содержит все остальные столбцы конфигурации сценария (переключатели функций, пороги, действия при предупреждениях, разрешённые документы, обратные вызовы) в качестве дополнительных свойств. Поля, неприменимые к `workflow_type`, имеют значение `null`. properties: uuid: type: string format: uuid description: >- Идентификатор конкретной версии (`settings_uuid`). Каждая версия сценария имеет собственный идентификатор. workflow_id: type: string format: uuid description: >- Постоянный идентификатор, общий для всех версий сценария. Созданные с его помощью сессии используют последнюю опубликованную версию. workflow_label: type: string description: Отображаемое имя сценария. workflow_type: type: string nullable: true enum: - kyc - kyb - adaptive_age_verification - biometric_authentication - address_verification - questionnaire_verification - email_verification - phone_verification - null description: >- Шаблон сценария. `null` для графовых сценариев, созданных без шаблона. is_default: type: boolean description: Является ли этот сценарий сценарием по умолчанию для приложения. is_archived: type: boolean description: Архивные сценарии не могут запускать новые сессии. version: type: integer description: Номер версии внутри сценария. status: type: string enum: - draft - published description: >- Черновые версии можно редактировать; опубликованные версии неизменяемы и используются для новых сессий. published_at: type: string format: date-time nullable: true description: Когда была опубликована эта версия. `null` для черновиков. is_simple_workflow: type: boolean description: '`true`, если сценарий не имеет пользовательского `workflow_graph`.' is_editable: type: boolean description: '`true` только для версий со статусом `draft`.' workflow_url: type: string format: uri description: Публичный URL для запуска сессии с этим сценарием. workflow_graph: type: object nullable: true additionalProperties: true description: >- Структура графа сценария (узлы и рёбра). `null` для простых сценариев. features: type: string description: >- Включенные функции, объединенные через `" + "`, например `"OCR + LIVENESS"`. total_price: type: number nullable: true description: Цена за сессию; для графовых сценариев это самый дорогой путь. min_price: type: number nullable: true description: Цена самого дешёвого пути в сценарии. max_price: type: number nullable: true description: Цена самого дорогого пути в сценарии. special_add_on_prices: type: object nullable: true additionalProperties: true description: >- Специальные цены на дополнения для организации или `null`, если они не заданы. max_retry_attempts: type: integer description: >- Количество повторных попыток, разрешенных после отклоненной верификации. retry_window_days: type: integer nullable: true description: Количество дней, в течение которых разрешены повторные попытки. session_expiration_time: type: integer description: Количество секунд до истечения срока незавершённой сессии. questionnaire: type: object nullable: true additionalProperties: true description: Анкета, прикрепленная к сценарию, или `null`. kyb_role_settings: type: array items: type: object additionalProperties: true description: Настройки верификации по ролям для ключевых лиц KYB. created_at: type: string format: date-time updated_at: type: string format: date-time signature_availability: type: object description: >- Какие уровни Электронной подписи доступны для подписания прямо сейчас. Проверьте это перед установкой `signature_level`. Возвращается в сценариях `kyc`, `kyb` и графовых сценариях. properties: simple: type: boolean description: Simple доступен всегда. aes: type: boolean description: >- Доступна ли сейчас подпись с расширенным уровнем (AES). Пока значение `false`, сохранение нового шага с `signature_level: "aes"` отклоняется с ошибкой `aes_not_available`. qes: type: boolean description: >- Доступна ли сейчас подпись с квалифицированным уровнем (QES). Имеет значение `false`, пока не подключен квалифицированный провайдер. is_bank_verification_enabled: type: boolean description: >- Выполняется ли в простом сценарии KYC или KYB верификация банка. Она выполняется после шагов контакта (и верификации местоположения) и перед проверкой по базам данных, AML и анализом IP. Верификация банка пока не является общедоступной: её включение отклоняется везде, где она не активирована. bank_verification_config: type: object additionalProperties: true description: >- Настройки верификации банковских счетов простого сценария с теми же ключами, которые принимает узел `BANK_VERIFICATION` (например, `bank_countries` и `bank_method_order`). Неизвестные ключи отбрасываются. Каждый ключ необязателен, а отсутствующий ключ сохраняет значение по умолчанию, поэтому `{}` означает использование всех значений по умолчанию. См. раздел [Настройки верификации счетов](/ru/management-api/workflows/feature-configs#верификация-банка). example: {} is_geolocation_enabled: type: boolean description: >- Выполняется ли в простом сценарии KYC верификация местоположения. Она выполняется после шагов контакта и перед верификацией банка и проверкой по базам данных. В сценариях верификации бизнеса (KYB) этот шаг недоступен. geolocation_config: type: object additionalProperties: true description: >- Настройки верификации местоположения для простого сценария с теми же ключами, которые принимает узел `GEOLOCATION` (например, `is_geolocation_geofencing_enabled` и `geolocation_max_attempts`). Неизвестные ключи отбрасываются. Каждый ключ необязателен; отсутствующий ключ сохраняет значение по умолчанию, поэтому `{}` означает использование всех значений по умолчанию. example: {} additionalProperties: true 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.