> ## 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 списка сценариев: получение workflows через Didit
> Получайте все KYC- и KYB-сценарии вашей организации Didit через API. Управляйте сценариями верификации программно. Оплата по использованию, без контрактов.
Промпт API для получения списка сценариев
Скопировать промпт в буфер обмена
\
\`List every Didit workflow in my application through the Management API.
Endpoint:
GET https://verification.didit.me/v3/workflows/
Authentication:
Use the x-api-key header with my Didit API key.
Goal:
\- Retrieve every workflow (verification settings record) defined for the application bound to my API key.
\- Use the results to render a workflow picker, sync workflow ids into my config, or discover the workflow_id of a workflow created in the Console.
Behavior:
\- Results are returned newest first (ordered by -created_at).
\- The endpoint does not paginate today — every workflow record comes back in one response.
\- Each row is a single version of a workflow group. workflow_id is the stable identifier shared by every version, version is the integer version number, and status is "draft" or "published".
\- The workflow with is_default: true is used whenever a session is created without an explicit workflow_id.
\- is_editable: true means the row is a draft and can still be patched via PATCH /v3/workflows/{settings_uuid}/.
\- Filter client-side by is_archived and status if you maintain hundreds of workflows.
Example call:
curl -X GET "https://verification.didit.me/v3/workflows/" \
-H "x-api-key: YOUR_API_KEY"
What to do with the response:
\- Use settings_uuid as the path id for GET / PATCH / DELETE /v3/workflows/{settings_uuid}/.
\- Use workflow_id when creating a session via POST /v3/session/.
Failure modes:
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope when the API key cannot list workflows for this application.
\- 429 — rate limited; back off and retry using Retry-After.
Side effects: none. This is a pure read.
For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`
\
Вставьте в
## OpenAPI
````yaml ru/openapi-25.json GET /v3/workflows/
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/:
get:
tags:
- Workflows
summary: Получить список сценариев
description: >-
Получить список ваших сценариев, сначала новые, в конверте пагинации
limit/offset (`{count, next, previous, results}`, размер страницы по
умолчанию 50). Каждая строка представляет собой одну версию;
`workflow_id` является стабильным идентификатором группы, а новые сессии
используют последнюю версию со статусом `published`.
operationId: list_workflows
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 50
description: Размер страницы (количество сценариев на странице).
- name: offset
in: query
required: false
schema:
type: integer
default: 0
description: Количество строк, пропускаемых перед первым возвращаемым сценарием.
responses:
'200':
description: >-
Одна страница сценариев, отсортированных по `created_at` по
убыванию, обёрнутая в структуру пагинации. Каждый элемент в
`results` представляет собой `WorkflowListItem`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Общее количество версий сценария для приложения.
next:
type: string
format: uri
nullable: true
description: URL следующей страницы или `null` на последней странице.
previous:
type: string
format: uri
nullable: true
description: URL предыдущей страницы или `null` на первой странице.
results:
type: array
items:
$ref: '#/components/schemas/WorkflowListItem'
examples:
Two workflows:
summary: Сценарий KYC по умолчанию и черновой сценарий KYC + AML
value:
count: 2
next: null
previous: null
results:
- 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_white_label_enabled: false
total_price: 0.15
min_price: 0.15
max_price: 0.15
features: OCR + LIVENESS + FACE_MATCH
is_simple_workflow: true
is_editable: false
workflow_url: https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ
max_retry_attempts: 3
retry_window_days: 7
session_expiration_time: 604800
version: 2
status: published
has_draft: false
created_by:
name: Alex Mateo
email: alex@example.com
type: user
updated_at: '2026-04-12T10:30:00Z'
- uuid: b2c3d4e5-6789-01bc-defa-222222222222
workflow_id: b2c3d4e5-6789-01bc-defa-222222222222
workflow_label: Full Verification + AML
workflow_type: kyc
is_default: false
is_archived: false
is_white_label_enabled: false
total_price: 0.25
min_price: 0.25
max_price: 0.25
features: OCR + LIVENESS + FACE_MATCH + AML
is_simple_workflow: true
is_editable: true
workflow_url: https://verify.didit.me/u/Aq3kPOx8RWG3UAz5ZRQGVQ
max_retry_attempts: 3
retry_window_days: 7
session_expiration_time: 604800
version: 1
status: draft
has_draft: true
created_by: null
updated_at: '2026-04-15T18:05:21Z'
'403':
description: >-
API-ключ отсутствует, сформирован неверно, истёк или принадлежит
другому приложению. Тело ответа: `{"detail": "You do not have
permission to perform this action."}`. Обновите токен через [Auth
API](/ru/auth-api/get-credentials) и повторите попытку.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
examples:
Invalid token:
value:
detail: You do not have permission to perform this action.
'429':
description: >-
Превышен лимит запросов. Повторите попытку с экспоненциальной
задержкой и учитывайте любой заголовок `Retry-After`.
'500':
description: >-
Непредвиденная ошибка сервера при формировании списка. Запрос можно
безопасно повторить.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -X GET 'https://verification.didit.me/v3/workflows/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Accept: application/json'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.workflows.list():
print(item)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.workflows.list()) {
console.log(item);
}
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Workflows.ListAutoPaging(ctx, didit.WorkflowsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
- lang: java
label: Java
source: |-
import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.workflows().list()) {
System.out.println(item);
}
- lang: php
label: PHP
source: |-
workflows->list() as $item) {
print_r($item->toArray());
}
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.workflows.list.auto_paging_each do |item|
puts item.to_h
end
- lang: csharp
label: .NET
source: |-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Workflows.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}
components:
schemas:
WorkflowListItem:
type: object
description: Одна версия сценария в представлении списка.
properties:
uuid:
type: string
format: uuid
description: >-
UUID конкретной версии. Используется как `{settings_uuid}` для
получения, обновления и удаления и как `workflow_id` при создании
сессий.
workflow_id:
type: string
format: uuid
description: >-
Постоянный ID группы, общий для всех версий одного и того же
сценария. Равен `uuid` для версии 1.
workflow_label:
type: string
description: Отображаемое имя для сценария.
workflow_type:
type: string
nullable: true
description: >-
Базовый тип простых сценариев: `kyc`, `kyb`,
`adaptive_age_verification`, `biometric_authentication` и т. д.
`null` для сценариев на основе графа без функции KYB.
is_default:
type: boolean
description: Является ли этот сценарий сценарием по умолчанию для новых сессий.
is_archived:
type: boolean
is_white_label_enabled:
type: boolean
description: >-
Применяется ли кастомизация White label к сессиям, созданным с
помощью этого сценария.
total_price:
type: number
description: >-
Фиксированная цена за верификацию в USD (число JSON, исключает
функции с переменной ценой, такие как DATABASE_VALIDATION и
PHONE_VERIFICATION).
min_price:
type: number
description: Минимальная фиксированная цена по путям графа сценария, в USD.
max_price:
type: number
description: Самая высокая фиксированная цена среди путей графа сценария, в USD.
features:
type: string
description: >-
Включенные функции в виде единой строки, разделенной `" + "`,
например `"OCR + LIVENESS + FACE_MATCH"`. Разделите по `" + "`,
чтобы получить список.
is_simple_workflow:
type: boolean
description: True, когда у сценария нет кастомного графа сценария.
is_editable:
type: boolean
description: >-
Имеет значение true, если эта версия является `draft` (черновики
можно редактировать на месте; опубликованные версии в Console
неизменяемы).
workflow_url:
type: string
format: uri
description: >-
Публичная ссылка на верификацию для этого сценария
(`https://verify.didit.me/u/`).
max_retry_attempts:
type: integer
description: >-
Максимальное количество повторных попыток после отклонения
верификации (0-10).
retry_window_days:
type: integer
nullable: true
description: >-
Скользящее окно в днях для подсчёта повторных попыток (1-365).
`null` = лимит за всё время.
session_expiration_time:
type: integer
description: >-
Количество секунд до истечения срока незавершённой сессии
(3600-2419200).
version:
type: integer
description: Номер версии внутри группы `workflow_id`, начиная с 1.
status:
type: string
enum:
- draft
- published
description: >-
Статус версии. Новые сессии используют последнюю опубликованную
версию (`published`) группы.
has_draft:
type: boolean
description: >-
True, когда любая версия в этой группе `workflow_id` в данный момент
является черновиком.
created_by:
type: object
nullable: true
description: >-
Кто создал эту версию: `{name, email, type}`, где `type` имеет
значение `user` (пользователь консоли, поле `email` заполнено) или
`api_key` (поле `name` содержит идентификатор клиента, `email` равен
null). `null`, если создатель не был зафиксирован.
properties:
name:
type: string
email:
type: string
nullable: true
type:
type: string
enum:
- user
- api_key
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.