Начало работы
Интеграция / SDK
Проверка пользователей
Верификация бизнеса
Мониторинг транзакций
Журнал измененийcURL
curl -X POST 'https://verification.didit.me/v3/workflows/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"workflow_label": "Standard KYC",
"features": [
{"feature": "OCR"},
{"feature": "LIVENESS", "config": {"face_liveness_method": "passive"}},
{"feature": "FACE_MATCH", "config": {"face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60}}
]
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.workflows.create(
workflow_label="Standard KYC",
features=[{
"feature": "OCR",
"config": {"duplicated_user_action": "review"},
}, {
"feature": "LIVENESS",
"config": {"face_liveness_method": "passive"},
}, {
"feature": "FACE_MATCH",
"config": {"face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60},
}],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.workflows.create({
workflow_label: "Standard KYC",
features: [{
feature: "OCR",
config: { duplicated_user_action: "review" },
}, {
feature: "LIVENESS",
config: { face_liveness_method: "passive" },
}, {
feature: "FACE_MATCH",
config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },
}],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Workflows.Create(ctx, didit.SimpleWorkflowRequest{
WorkflowLabel: didit.String("Standard KYC"),
Features: []didit.SimpleWorkflowFeature{{
Feature: "OCR",
Config: didit.Some(map[string]any{"duplicated_user_action": "review"}),
}, {
Feature: "LIVENESS",
Config: didit.Some(map[string]any{"face_liveness_method": "passive"}),
}, {
Feature: "FACE_MATCH",
Config: didit.Some(map[string]any{"face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60}),
}},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.SimpleWorkflowFeature;
import me.didit.types.SimpleWorkflowRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.workflows().create(SimpleWorkflowRequest.builder()
.workflowLabel("Standard KYC")
.features(List.of(
SimpleWorkflowFeature.builder()
.feature(SimpleWorkflowFeature.Feature.of("OCR"))
.config(Map.of("duplicated_user_action", "review"))
.build(),
SimpleWorkflowFeature.builder()
.feature(SimpleWorkflowFeature.Feature.of("LIVENESS"))
.config(Map.of("face_liveness_method", "passive"))
.build(),
SimpleWorkflowFeature.builder()
.feature(SimpleWorkflowFeature.Feature.of("FACE_MATCH"))
.config(Map.of("face_match_score_decline_threshold", 40, "face_match_score_review_threshold", 60))
.build()))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->workflows->create([
'workflow_label' => 'Standard KYC',
'features' => [[
'feature' => 'OCR',
'config' => ['duplicated_user_action' => 'review'],
], [
'feature' => 'LIVENESS',
'config' => ['face_liveness_method' => 'passive'],
], [
'feature' => 'FACE_MATCH',
'config' => ['face_match_score_decline_threshold' => 40, 'face_match_score_review_threshold' => 60],
]],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.workflows.create(
workflow_label: "Standard KYC",
features: [{
feature: "OCR",
config: { duplicated_user_action: "review" },
}, {
feature: "LIVENESS",
config: { face_liveness_method: "passive" },
}, {
feature: "FACE_MATCH",
config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },
}]
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Workflows.CreateAsync(new SimpleWorkflowRequest
{
WorkflowLabel = "Standard KYC",
Features = new SimpleWorkflowFeature[]
{
new()
{
Feature = "OCR",
Config = new Dictionary<string, object> { ["duplicated_user_action"] = "review" },
},
new()
{
Feature = "LIVENESS",
Config = new Dictionary<string, object> { ["face_liveness_method"] = "passive" },
},
new()
{
Feature = "FACE_MATCH",
Config = new Dictionary<string, object> { ["face_match_score_decline_threshold"] = 40, ["face_match_score_review_threshold"] = 60 },
},
},
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "c3d4e5f6-7890-12cd-ef34-333333333333",
"workflow_id": "c3d4e5f6-7890-12cd-ef34-333333333333",
"workflow_label": "Standard KYC",
"workflow_type": null,
"is_default": false,
"is_archived": false,
"total_price": 0.15,
"min_price": 0.15,
"max_price": 0.15,
"features": "OCR + LIVENESS + FACE_MATCH",
"is_simple_workflow": false,
"is_editable": false,
"workflow_url": "https://verify.didit.me/u/w9TkPOx8RWG3UAz5ZRQGVQ",
"workflow_graph": {
"start_node": "ocr",
"nodes": "... one node per feature plus a final status node ..."
},
"max_retry_attempts": 3,
"retry_window_days": 7,
"session_expiration_time": 604800,
"version": 1,
"status": "published",
"published_at": "2026-05-17T10:30:00Z",
"created_at": "2026-05-17T10:30:00Z",
"updated_at": "2026-05-17T10:30:00Z"
}Сценарии
API для создания сценария верификации: KYC-флоу
Создайте сценарий верификации Didit через API: упорядоченные функции KYC, KYB, AML и биометрия в одном потоке. Оплата за вызов, без контрактов.
POST
/
v3
/
workflows
/
cURL
curl -X POST 'https://verification.didit.me/v3/workflows/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"workflow_label": "Standard KYC",
"features": [
{"feature": "OCR"},
{"feature": "LIVENESS", "config": {"face_liveness_method": "passive"}},
{"feature": "FACE_MATCH", "config": {"face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60}}
]
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.workflows.create(
workflow_label="Standard KYC",
features=[{
"feature": "OCR",
"config": {"duplicated_user_action": "review"},
}, {
"feature": "LIVENESS",
"config": {"face_liveness_method": "passive"},
}, {
"feature": "FACE_MATCH",
"config": {"face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60},
}],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.workflows.create({
workflow_label: "Standard KYC",
features: [{
feature: "OCR",
config: { duplicated_user_action: "review" },
}, {
feature: "LIVENESS",
config: { face_liveness_method: "passive" },
}, {
feature: "FACE_MATCH",
config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },
}],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Workflows.Create(ctx, didit.SimpleWorkflowRequest{
WorkflowLabel: didit.String("Standard KYC"),
Features: []didit.SimpleWorkflowFeature{{
Feature: "OCR",
Config: didit.Some(map[string]any{"duplicated_user_action": "review"}),
}, {
Feature: "LIVENESS",
Config: didit.Some(map[string]any{"face_liveness_method": "passive"}),
}, {
Feature: "FACE_MATCH",
Config: didit.Some(map[string]any{"face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60}),
}},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.SimpleWorkflowFeature;
import me.didit.types.SimpleWorkflowRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.workflows().create(SimpleWorkflowRequest.builder()
.workflowLabel("Standard KYC")
.features(List.of(
SimpleWorkflowFeature.builder()
.feature(SimpleWorkflowFeature.Feature.of("OCR"))
.config(Map.of("duplicated_user_action", "review"))
.build(),
SimpleWorkflowFeature.builder()
.feature(SimpleWorkflowFeature.Feature.of("LIVENESS"))
.config(Map.of("face_liveness_method", "passive"))
.build(),
SimpleWorkflowFeature.builder()
.feature(SimpleWorkflowFeature.Feature.of("FACE_MATCH"))
.config(Map.of("face_match_score_decline_threshold", 40, "face_match_score_review_threshold", 60))
.build()))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->workflows->create([
'workflow_label' => 'Standard KYC',
'features' => [[
'feature' => 'OCR',
'config' => ['duplicated_user_action' => 'review'],
], [
'feature' => 'LIVENESS',
'config' => ['face_liveness_method' => 'passive'],
], [
'feature' => 'FACE_MATCH',
'config' => ['face_match_score_decline_threshold' => 40, 'face_match_score_review_threshold' => 60],
]],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.workflows.create(
workflow_label: "Standard KYC",
features: [{
feature: "OCR",
config: { duplicated_user_action: "review" },
}, {
feature: "LIVENESS",
config: { face_liveness_method: "passive" },
}, {
feature: "FACE_MATCH",
config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },
}]
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Workflows.CreateAsync(new SimpleWorkflowRequest
{
WorkflowLabel = "Standard KYC",
Features = new SimpleWorkflowFeature[]
{
new()
{
Feature = "OCR",
Config = new Dictionary<string, object> { ["duplicated_user_action"] = "review" },
},
new()
{
Feature = "LIVENESS",
Config = new Dictionary<string, object> { ["face_liveness_method"] = "passive" },
},
new()
{
Feature = "FACE_MATCH",
Config = new Dictionary<string, object> { ["face_match_score_decline_threshold"] = 40, ["face_match_score_review_threshold"] = 60 },
},
},
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "c3d4e5f6-7890-12cd-ef34-333333333333",
"workflow_id": "c3d4e5f6-7890-12cd-ef34-333333333333",
"workflow_label": "Standard KYC",
"workflow_type": null,
"is_default": false,
"is_archived": false,
"total_price": 0.15,
"min_price": 0.15,
"max_price": 0.15,
"features": "OCR + LIVENESS + FACE_MATCH",
"is_simple_workflow": false,
"is_editable": false,
"workflow_url": "https://verify.didit.me/u/w9TkPOx8RWG3UAz5ZRQGVQ",
"workflow_graph": {
"start_node": "ocr",
"nodes": "... one node per feature plus a final status node ..."
},
"max_retry_attempts": 3,
"retry_window_days": 7,
"session_expiration_time": 604800,
"version": 1,
"status": "published",
"published_at": "2026-05-17T10:30:00Z",
"created_at": "2026-05-17T10:30:00Z",
"updated_at": "2026-05-17T10:30:00Z"
}
Используйте этот эндпоинт, чтобы создавать сценарии через API без самостоятельного построения узлов графа. Передайте массив
Порядок функций важен. Например,
Точный объект
В этом графе
Чтобы выразить «NFC не выполнялся ни по одной из известных причин», используйте
Каждое настроенное поле становится значением, по которому можно выполнять ветвление:
Невалидный граф возвращает
Финальный узел использует
features в том порядке, в котором пользователи должны проходить проверки. Didit преобразует его во внутренний сценарий на основе узлов и автоматически добавит финальный шаг со статусом.
Эндпоинт POST /v3/workflows/ создаёт только простые, линейные сценарии, то есть плоский список features. Для ветвления, условной маршрутизации, Document AI и узлов отказа/решения используйте формат графа с узлами, описанный ниже. Он лежит в основе визуального конструктора в консоли и инструментов сценариев Didit MCP.
Все поля config, которые принимает каждая функция, перечислены в разделе Конфигурации функций сценария.
Базовый сценарий KYC
{
"workflow_label": "Standard KYC",
"features": [
{
"feature": "OCR",
"config": {
"documents_allowed": {
"USA": {
"DL": {
"enabled": 1,
"sides": 2
}
}
},
"duplicated_user_action": "REVIEW"
}
},
{
"feature": "LIVENESS",
"config": {
"face_liveness_method": "PASSIVE"
}
},
{
"feature": "FACE_MATCH"
}
]
}
Сценарий с анкетой
Сначала создайте анкету с помощьюPOST /v3/questionnaires/. Затем используйте возвращённый questionnaire_id как questionnaire_uuid.
{
"workflow_label": "Source of Funds",
"features": [
{
"feature": "QUESTIONNAIRE",
"config": {
"questionnaire_uuid": "11111111-2222-3333-4444-555555555555",
"review_questionnaire_manually": true
}
}
]
}
OCR должен стоять перед FACE_MATCH, NFC, DATABASE_VALIDATION или проверками AML пользователя, которые зависят от данных документа.
Справочник по конфигурации функций
Каждый элементfeatures[] имеет такую структуру:
{
"feature": "OCR",
"label": "ID Verification",
"config": {}
}
config зависит от функции. Полный список полей, значения по умолчанию, обязательные настройки, допустимые диапазоны и примеры см. в разделе Конфигурации функций сценария.
Для OCR опустите config.documents_allowed, передайте null или {}, чтобы разрешить все поддерживаемые типы документов. Указывайте этот параметр, только если хотите ограничить сценарий определёнными странами или типами документов. Для QUESTIONNAIRE поле config.questionnaire_uuid обязательно.
Необязательные настройки сценария
При создании сценария можно добавить любое из этих полей верхнего уровня, чтобы управлять поведением сессии. Все они необязательны. Если поле не указано, используется значение по умолчанию сценария.| Поле | Тип | Описание |
|---|---|---|
is_white_label_enabled | boolean | Включает кастомизацию White label для сессий, созданных с этим сценарием. По умолчанию false. |
is_desktop_allowed | boolean | Разрешает запуск потока верификации в браузерах на десктопе. По умолчанию false. |
max_retry_attempts | integer (0–10) | Максимальное число повторных попыток после отклонённой верификации. 0 блокирует пользователя после первого отказа. По умолчанию 3. |
retry_window_days | integer (1–365) или null | Скользящее окно в днях, за которое считаются повторные попытки (null = лимит за всё время). По умолчанию 7. |
session_expiration_time | integer (3600–2419200) | Количество секунд до истечения незавершённой сессии. Минимум 1 час, максимум 4 недели. По умолчанию 604800 (7 дней). |
response_attributes | object или null | Ограничивает поля, возвращаемые для каждой функции, например {"id_verifications": ["full_name", "document_number"], "face_matches": null}. null или отсутствующий ключ возвращает все поля. Пустой список возвращает только status, warnings, node_id, is_nfc_skipped и skip_reason, а остальные поля приходят со значением null. |
{
"workflow_label": "Standard KYC",
"is_white_label_enabled": true,
"is_desktop_allowed": true,
"max_retry_attempts": 5,
"retry_window_days": 14,
"session_expiration_time": 86400,
"features": [
{ "feature": "OCR" },
{ "feature": "LIVENESS" },
{ "feature": "FACE_MATCH" }
]
}
Ветвления и сценарии на основе графа (граф)
Линейный списокfeatures не может выразить «если X, то Y». Для условного ветвления (отклонение по статусу, маршрутизация по извлечённому полю, условие шага по совпадению), шага запроса Document AI или терминальных узлов отклонения/решения сценарии Didit используют граф узлов, то есть ту же структуру, которую создаёт визуальный конструктор в консоли.
Проще всего создать сценарий на основе графа с помощью Didit MCP: попросите агента простыми словами («после верификации личности, если профессия ≈ “Software Engineer”, добавь шаг подтверждения наличия средств»), и он построит, проверит и сохранит граф за вас. Структура ниже соответствует тому, что создают эти инструменты и консоль.
Структура графа
Граф имеет вид{ start_node, nodes }. nodes — это словарь «идентификатор узла → узел». Рёбра неявные: каждый узел указывает вперёд через next (безусловно) и/или branches[].goto (условно).
| Тип узла | Структура |
|---|---|
feature | { "node_type": "feature", "feature": "OCR", "config": {…}, "next": "<id>", "branches": [] } |
branch | { "node_type": "branch", "branches": [ { "id", "logic": "and"|"or", "rules": [<rule>], "goto": "<id>" } ], "next": "<fallback id>" } |
status (терминальный) | { "node_type": "status", "session_status": "Approved"|"Declined"|"In Review"|"Determine" } |
action | { "node_type": "action", "actions": [ { "type": "add_tag"|"add_review"|… } ], "next": "<id>" } |
webhook | { "node_type": "webhook", "config": { "url", "method" }, "branches": [], "next": "<id>" } |
start_node должен быть узлом feature. Ветви проверяются по порядку, срабатывает первое совпадение. Пустой rules: [] — это общее правило «иначе» (ставьте его последним). session_status: "Determine" принимает решение автоматически на основе совокупного результата функций.
Каждый узел branch должен иметь явную ветвь else, то есть ветвь с
rules: [], которая направляет сессии, не подпадающие ни под одно условие. Не полагайтесь на next узла branch как на запасной вариант: голый next отображается в конструкторе как неоднозначное ребро и его легко пропустить. Если вы отправляете узел branch с next и без ветви else, API преобразует этот next в явную ветвь else автоматически (так, { …, "branches": [<conditions>], "next": "liveness" } сохраняется как branches: [<conditions>, { "id": "else", "rules": [], "goto": "liveness" }]). Создайте else сами, чтобы явно задать поведение: преобразование служит страховкой, а не заменой.Правила ветвления и операторы
Каждое правило сравнивает поле со значением с помощью оператора:{ "field": "kyc.extra_fields.profession", "operator": "fuzzy_match", "value": "Software Engineer", "score": 80 }
- Поля называют результат функции (
kyc.status,aml.status,document_ai.status,face_match.score, …) или извлечённое значение (kyc.full_name,kyc.age,kyc.nationality,kyc.extra_fields.profession, поле Document AIdocument_ai.<key>,expected_details.*). Ветвление может читать поле только в том случае, если соответствующая функция выполнялась на каждом пути, ведущем к этому ветвлению. - Операторы:
equals,not_equals,greater_than(_or_equals),less_than(_or_equals),contains,not_contains,in,not_in,is_empty,is_not_empty,regexиfuzzy_match(только для строковых полей; требуетscoreот 0 до 100, то есть порог сходства, например: профессия ≥ 80% похожа на «Software Engineer»).
Ветвление по причине, по которой NFC не выполнялся
После узлаNFC используйте nfc.skip_reason с equals или in, чтобы направлять сессии по причине, по которой чтение чипа не состоялось. Поле имеет семь стабильных значений:
USER_SKIPPEDDOCUMENT_WITHOUT_CHIPCHIP_CERTIFICATE_UNAVAILABLEDEVICE_WITHOUT_NFCINTEGRATION_WITHOUT_NFC_ACCESSMRZ_KEY_UNAVAILABLEJPKI_UNAVAILABLE
nfc.skip_reason равен null, поэтому ни правило equals, ни правило in для причины пропуска не сработают.
Поле также вычисляется для узлов NFC, пропущенных гейтом. Сюда входят случаи, когда отчёта или предупреждения NFC нет, и случаи, когда allow_nfc_skip равен false, но документ или устройство не позволяют NFC запуститься. Поэтому такие сессии можно направлять, не полагаясь на запись в nfc_verifications[].
Сессии, сохранённые до того, как поддержка NFC стала иметь три состояния, могут иметь
has_device_nfc_support: false. Поэтому более старая веб-сессия может определяться как DEVICE_WITHOUT_NFC, а не INTEGRATION_WITHOUT_NFC_ACCESS.equals используется для пропуска пользователем, in для пропусков по гейту или возможностям, а явная ветвь else — для успешного NFC. Ветвление идёт после узла NFC, и каждый маршрут ведёт вперёд к терминальному узлу:
{
"start_node": "ocr",
"nodes": {
"ocr": {
"node_type": "feature",
"feature": "OCR",
"next": "nfc"
},
"nfc": {
"node_type": "feature",
"feature": "NFC",
"config": { "allow_nfc_skip": false },
"next": "route_nfc"
},
"route_nfc": {
"node_type": "branch",
"branches": [
{
"id": "user_skipped",
"logic": "and",
"rules": [
{ "field": "nfc.skip_reason", "operator": "equals", "value": "USER_SKIPPED" }
],
"goto": "manual_review"
},
{
"id": "nfc_unavailable",
"logic": "and",
"rules": [
{
"field": "nfc.skip_reason",
"operator": "in",
"value": [
"DOCUMENT_WITHOUT_CHIP",
"CHIP_CERTIFICATE_UNAVAILABLE",
"DEVICE_WITHOUT_NFC",
"INTEGRATION_WITHOUT_NFC_ACCESS",
"MRZ_KEY_UNAVAILABLE",
"JPKI_UNAVAILABLE"
]
}
],
"goto": "manual_review"
},
{
"id": "else",
"logic": "and",
"rules": [],
"goto": "approved"
}
]
},
"manual_review": { "node_type": "status", "session_status": "In Review" },
"approved": { "node_type": "status", "session_status": "Approved" }
}
}
in со всеми семью значениями. Оставьте явную ветвь else для успешного NFC (nfc.skip_reason: null) и для любого будущего значения, которое ваш граф пока не распознаёт.
Document AI (например, подтверждение наличия средств)
УзелDOCUMENT_AI запрашивает один или несколько документов и извлекает именованные поля:
{
"node_type": "feature",
"feature": "DOCUMENT_AI",
"label": "Proof of Funds",
"config": {
"document_ai_documents": [
{
"document_key": "proof_of_funds",
"title": "Proof of Funds",
"description": "Upload a recent bank statement.",
"fields": [
{
"key": "account_holder",
"name": "Account holder",
"instruction": "The full name of the account holder as printed on the statement.",
"type": "text",
"required": true,
"is_full_name": true
},
{
"key": "closing_balance",
"name": "Closing balance",
"instruction": "The closing balance amount.",
"type": "number",
"required": true
}
]
}
],
"document_ai_missing_required_fields_action": "REVIEW",
"document_ai_name_mismatch_action": "REVIEW"
},
"next": "final_decision"
}
document_ai.<key>, а результатом шага является document_ai.status.
Установите "is_full_name": true для поля, в котором содержится полное имя держателя документа. Его извлечённое значение сравнивается с полным именем проверенной личности (имя из OCR или верификации личности либо ожидаемые данные сессии). document_ai_name_mismatch_action определяет, что произойдёт при несовпадении ниже document_ai_name_match_score_threshold. Флаг необязательный: для документа можно не указывать ни одного поля, но не более одного поля в документе может иметь этот флаг. Все поля конфигурации Document AI см. в разделе Конфигурация функций сценария → Document AI.
Эндпоинты и жизненный цикл черновика
Редактирование графа выполняется для каждого приложения и использует эндпоинты консоли и управления (Bearer-токен пользователя +read:workflows/write:workflows). Граф можно редактировать только в черновой версии, поэтому жизненный цикл такой: создать черновик → задать граф → опубликовать.
| Метод | Путь | Назначение |
|---|---|---|
GET | …/verification-settings/{settings_uuid}/workflow-graph/ | Текущий граф + status/is_editable |
POST | …/application/{app}/workflow-graph/validate/ (body { "graph": … }) | Проверка без сохранения (пробный запуск) |
GET | …/application/{app}/workflow-graph/field-definitions/ | Поля, по которым можно ветвить, и допустимые операторы |
POST | …/verification-settings/{settings_uuid}/create-draft/ | Редактируемый черновик из опубликованной версии |
PUT | …/verification-settings/{settings_uuid}/workflow-graph/ (body { "graph": … }) | Сохранить граф |
PATCH | …/verification-settings/{settings_uuid}/ (body { "status": "published" }) | Опубликовать черновик |
Предупреждения валидации
Endpoint валидации возвращает{ "is_valid": true, "graph": …, "warnings": [] }. Предупреждение носит рекомендательный характер: граф корректен, его можно сохранить и опубликовать, даже если предупреждения есть. Каждая запись содержит узел ветвления и ветку, к которой она относится, чтобы конструктор мог указать на конкретное условие:
{
"type": "branch_outcome_contradiction",
"node_id": "after_ocr",
"branch_id": "b1",
"severity": "warning",
"message": "Branch 1 only matches sessions where ID Verification Status is Approved or In Review, but every path from it ends in the session outcome \"Declined\". Check the condition or the outcome.",
"params": { "branchNumber": 1, "field": "ID Verification Status", "allowed": "Approved or In Review", "outcome": "Declined" }
}
type | Что это означает |
|---|---|
branch_outcome_contradiction | Условие ветки и результат, к которому приводит каждый путь из неё, противоречат друг другу. Например, kyc.status NOT EQUALS Declined, направленное в результат Declined. Результат может находиться через несколько шагов дальше по пути. |
branch_condition_unreachable | Ветка никогда не сработает, потому что каждый путь, ведущий к этому ветвлению, уже ограничивает поле статуса значениями, которые условие исключает. |
else_branch_unreachable | Ветка else никогда не выполнится: остальные ветки уже покрывают все значения, которые поле может здесь принимать. |
400 с errors и списком warnings по возможности. Только errors блокируют сохранение.
Пример: направить инженеров-программистов на подтверждение наличия средств
После верификации личности: если она была отклонена, отклонить сессию; если профессия владельца ≈ “Software Engineer” (сходство ≥80%), запросить документ, подтверждающий наличие средств; затем принять окончательное решение.
{
"start_node": "ocr_1",
"nodes": {
"ocr_1": { "node_type": "feature", "feature": "OCR", "label": "ID Verification", "next": "after_ocr" },
"after_ocr": {
"node_type": "branch",
"label": "Route after ID verification",
"branches": [
{ "id": "declined", "logic": "or", "rules": [ { "field": "kyc.status", "operator": "equals", "value": "Declined" } ], "goto": "decline" },
{ "id": "software_engineer", "logic": "and", "rules": [ { "field": "kyc.extra_fields.profession", "operator": "fuzzy_match", "value": "Software Engineer", "score": 80 } ], "goto": "proof_of_funds" },
{ "id": "else", "logic": "and", "rules": [], "goto": "final_decision" }
]
},
"proof_of_funds": {
"node_type": "feature",
"feature": "DOCUMENT_AI",
"label": "Proof of Funds",
"config": {
"document_ai_documents": [
{ "document_key": "proof_of_funds", "title": "Proof of Funds", "description": "Upload a recent bank statement.",
"fields": [
{ "key": "account_holder", "name": "Account holder", "type": "text", "required": true },
{ "key": "closing_balance", "name": "Closing balance", "type": "number", "required": true }
] }
],
"document_ai_missing_required_fields_action": "REVIEW"
},
"next": "final_decision"
},
"final_decision": { "node_type": "status", "session_status": "Determine", "label": "Final decision" },
"decline": { "node_type": "status", "session_status": "Declined", "label": "Declined" }
}
}
session_status: "Determine", который автоматически принимает решение (одобрить / отклонить / отправить на проверку) на основе тех функций, которые реально выполнялись в сессии. Поэтому и путь с подтверждением наличия средств, и путь else корректно приводят к решению, без того чтобы какая-либо ветка читала document_ai.status (этого поля нет на пути, где Document AI пропускается). Помните: ветвь может читать только то поле, функция которого выполнялась на каждом пути, ведущем к ней.
Отправьте его в виде { "graph": <above> } на endpoint …/workflow-graph/ (сначала выполните валидацию). Чтобы создать новый сценарий с нуля, используйте didit_workflow_set_graph из MCP; чтобы изменить существующий сценарий, используйте didit_workflow_edit_graph (небольшие операции, которые сохраняют существующие узлы и списки разрешённых значений). См. Didit MCP.Авторизации
API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.
Тело
application/json
Создайте простой линейный сценарий. API преобразует этот список функций во внутренний граф сценария на основе узлов. СТРОГИЙ белый список полей: любой ключ, не указанный здесь (включая workflow_type), отклоняется с кодом 400.
Функции верификации в порядке выполнения. API связывает каждый элемент со следующим и автоматически добавляет один финальный узел статуса.
Minimum array length:
1Show child attributes
Show child attributes
Отображаемое имя для сценария (максимум 50 символов). По умолчанию "ID Verification", если параметр опущен — всегда задавайте его, чтобы сценарии оставались различимыми.
Maximum string length:
50Пример:
"Standard KYC"
Установить этот сценарий по умолчанию для новых сессий.
Опустите это поле, чтобы создать опубликованный сценарий, готовый к запуску сессий. Используйте draft, только если хотите сохранить без публикации.
Доступные опции:
draft, published Включить кастомизацию White label для сессий, созданных с этим сценарием.
Разрешить запуск сценария верификации в браузерах на десктопе.
Максимальное количество повторных попыток после отклонения верификации. 0 блокирует пользователя после первого отклонения.
Требуемый диапазон:
0 <= x <= 10Скользящее окно в днях для подсчёта повторных попыток. null устанавливает лимит за всё время.
Требуемый диапазон:
1 <= x <= 365Максимальное количество попыток проверки живости за сессию. По умолчанию 3: одна начальная попытка плюс две повторные попытки. Это значение также копируется в сгенерированные узлы проверки живости и оценки возраста в сценарии, если только оно не переопределено в конфигурации на уровне функции.
Требуемый диапазон:
1 <= x <= 3Максимальное количество попыток сравнения лиц за сессию. По умолчанию 3: одна начальная попытка плюс две повторные попытки. Это значение также копируется в сгенерированные узлы сравнения лиц в сценарии, если только оно не переопределено в конфигурации на уровне функции.
Требуемый диапазон:
1 <= x <= 3Количество секунд до истечения срока незавершённой сессии. Минимум 1 час (3600), максимум 4 недели (2419200).
Требуемый диапазон:
3600 <= x <= 2419200Ответ
Сценарий создан. Тело ответа представляет собой ПОЛНУЮ конфигурацию сценария — ту же исходную сериализацию VerificationSettings, возвращаемую GET /v3/workflows/{settings_uuid}/ (~190 полей: переключатель каждой функции, порог, действие и сгенерированный workflow_graph), а не компактный элемент списка. Сохраните uuid (также доступный как workflow_id), чтобы ссылаться на него в последующих вызовах создания сессий. Примечание: features представляет собой строку, объединённую с помощью " + ", а цены являются числами JSON.
Поля ниже являются типизированными; объект также содержит все остальные столбцы конфигурации сценария (переключатели функций, пороги, действия при предупреждениях, разрешённые документы, обратные вызовы) в качестве дополнительных свойств. Поля, неприменимые к workflow_type, имеют значение null.
Идентификатор конкретной версии (settings_uuid). Каждая версия сценария имеет собственный идентификатор.
Постоянный идентификатор, общий для всех версий сценария. Созданные с его помощью сессии используют последнюю опубликованную версию.
Отображаемое имя сценария.
Шаблон сценария. null для графовых сценариев, созданных без шаблона.
Доступные опции:
kyc, kyb, adaptive_age_verification, biometric_authentication, address_verification, questionnaire_verification, email_verification, phone_verification, null Является ли этот сценарий сценарием по умолчанию для приложения.
Архивные сценарии не могут запускать новые сессии.
Номер версии внутри сценария.
Черновые версии можно редактировать; опубликованные версии неизменяемы и используются для новых сессий.
Доступные опции:
draft, published Когда была опубликована эта версия. null для черновиков.
true, если сценарий не имеет пользовательского workflow_graph.
true только для версий со статусом draft.
Публичный URL для запуска сессии с этим сценарием.
Структура графа сценария (узлы и рёбра). null для простых сценариев.
Включенные функции, объединенные через " + ", например "OCR + LIVENESS".
Цена за сессию; для графовых сценариев это самый дорогой путь.
Цена самого дешёвого пути в сценарии.
Цена самого дорогого пути в сценарии.
Специальные цены на дополнения для организации или null, если они не заданы.
Количество повторных попыток, разрешенных после отклоненной верификации.
Количество дней, в течение которых разрешены повторные попытки.
Количество секунд до истечения срока незавершённой сессии.
Анкета, прикрепленная к сценарию, или null.
Настройки верификации по ролям для ключевых лиц KYB.
Какие уровни Электронной подписи доступны для подписания прямо сейчас. Проверьте это перед установкой signature_level. Возвращается в сценариях kyc, kyb и графовых сценариях.
Show child attributes
Show child attributes
Выполняется ли в простом сценарии KYC или KYB верификация банка. Она выполняется после шагов контакта (и верификации местоположения) и перед проверкой по базам данных, AML и анализом IP. Верификация банка пока не является общедоступной: её включение отклоняется везде, где она не активирована.
Настройки верификации банковских счетов простого сценария с теми же ключами, которые принимает узел BANK_VERIFICATION (например, bank_countries и bank_method_order). Неизвестные ключи отбрасываются. Каждый ключ необязателен, а отсутствующий ключ сохраняет значение по умолчанию, поэтому {} означает использование всех значений по умолчанию. См. раздел Настройки верификации счетов.
Пример:
{}
Выполняется ли в простом сценарии KYC верификация местоположения. Она выполняется после шагов контакта и перед верификацией банка и проверкой по базам данных. В сценариях верификации бизнеса (KYB) этот шаг недоступен.
Настройки верификации местоположения для простого сценария с теми же ключами, которые принимает узел GEOLOCATION (например, is_geolocation_geofencing_enabled и geolocation_max_attempts). Неизвестные ключи отбрасываются. Каждый ключ необязателен; отсутствующий ключ сохраняет значение по умолчанию, поэтому {} означает использование всех значений по умолчанию.
Пример:
{}
Последнее изменение 7 ноября 2026 г.