ابدأ الآن
التكامل / SDKs
التحقق من المستخدمين
التحقق من الشركات
مراقبة المعاملات
سجل التغييرات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 برمجياً بميزات مرتبة: 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 | قيمة منطقية | تفعيل تخصيص العلامة البيضاء للجلسات المُنشأة بسير العمل هذا. الافتراضي false. |
is_desktop_allowed | قيمة منطقية | السماح بتشغيل مسار التحقق على متصفحات سطح المكتب. الافتراضي false. |
max_retry_attempts | عدد صحيح (0–10) | الحد الأقصى لمحاولات إعادة المحاولة المسموح بها بعد عملية تحقق مرفوضة. القيمة 0 تحظر المستخدم بعد أول رفض. الافتراضي 3. |
retry_window_days | عدد صحيح (1–365) أو null | نافذة متدحرجة بالأيام تُستخدم لاحتساب المحاولات (null = حد غير مقيّد بمدة زمنية). الافتراضي 7. |
session_expiration_time | عدد صحيح (3600–2419200) | عدد الثواني قبل انتهاء صلاحية الجلسة غير المكتملة. الحد الأدنى ساعة واحدة، والحد الأقصى 4 أسابيع. الافتراضي 604800 (7 أيام). |
response_attributes | كائن أو 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: [] فارغة هو الفرع الاحتياطي “else” الذي يشمل كل ما عداه، ويجب أن يأتي في الآخر. تقرّر القيمة session_status: "Determine" النتيجة تلقائياً من مجموع نتائج الميزات.
يجب أن تحتوي كل عقدة فرع على فرع else صريح، أي فرع بـ
rules: [] يوجّه الجلسات التي لا تطابق أيّاً من الشروط. لا تعتمد على next الخاصة بعقدة الفرع كبديل احتياطي: فحقل next المفرد يظهر كحافة غامضة في المنشئ المرئي، ويسهل نسيانه. عندما ترسل عقدة فرع تحمل 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، والحالات التي تكون فيها القيمة 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.
نقاط endpoint ودورة حياة المسودة
يتم تحرير المخطط لكل تطبيق، ويستخدم نقاط endpoint الخاصة بوحدة التحكم والإدارة (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" }) | نشر المسودة |
تحذيرات التحقق
تُرجع نقطة التحقق{ "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> } إلى نقطة …/workflow-graph/ (تحقّق منه أولاً). لإنشاء سير عمل جديد من الصفر، استخدم أداة didit_workflow_set_graph في MCP. ولتعديل سير عمل موجود، استخدم didit_workflow_edit_graph (عمليات صغيرة، تحافظ على العقد الموجودة وقوائم السماح). راجع Didit MCP.التفويضات
مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ 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 تمكين تخصيص العلامة البيضاء للجلسات التي تم إنشاؤها باستخدام سير العمل هذا.
السماح بتشغيل مسار التحقق على متصفحات أجهزة سطح المكتب.
الحد الأقصى لمحاولات إعادة المحاولة المسموح بها بعد عملية تحقق مرفوضة. القيمة 0 تحظر المستخدم بعد الرفض الأول.
النطاق المطلوب:
0 <= x <= 10النافذة الزمنية المتجددة بالأيام المستخدمة لحساب عمليات إعادة المحاولة. تفرض القيمة null حداً طوال الوقت.
النطاق المطلوب:
1 <= x <= 365الحد الأقصى لعمليات إرسال كشف الحيوية لكل جلسة. القيمة الافتراضية 3: محاولة أولية واحدة بالإضافة إلى محاولتي إعادة. يتم أيضاً نسخ هذه القيمة في عُقد سير عمل كشف الحيوية وتقدير العمر المنشأة ما لم يستبدلها إعداد على مستوى الميزة.
النطاق المطلوب:
1 <= x <= 3الحد الأقصى لعمليات إرسال مطابقة الوجه لكل جلسة. القيمة الافتراضية 3: محاولة أولية واحدة بالإضافة إلى محاولتي إعادة. يتم أيضاً نسخ هذه القيمة في عُقد سير عمل مطابقة الوجه المنشأة ما لم يستبدلها إعداد على مستوى الميزة.
النطاق المطلوب:
1 <= x <= 3عدد الثواني قبل انتهاء صلاحية الجلسة غير المكتملة. الحد الأدنى ساعة واحدة (3600)، والحد الأقصى 4 أسابيع (2419200).
النطاق المطلوب:
3600 <= x <= 2419200الاستجابة
تم إنشاء سير العمل. نص الاستجابة هو التكوين الكامل لسير العمل — نفس التسلسل الخام لـ VerificationSettings الذي يعود من GET /v3/workflows/{settings_uuid}/ (حوالي 190 حقلاً: كل تبديل ميزة، وحد، وإجراء، وworkflow_graph المُنشأ)، وليس عنصر القائمة المضغوط. قم بتخزين uuid (المعروض أيضاً باسم workflow_id) لتتمكن من الرجوع إليه في استدعاءات إنشاء الجلسة لاحقاً. ملاحظة: features هي سلسلة متصلة بـ " + " والأسعار هي أرقام JSON.
الحقول أدناه ذات أنواع محددة (typed)؛ ويحمل الكائن أيضاً كل عمود آخر من تكوين سير العمل (مفاتيح تبديل الميزات، والحدود، وإجراءات التحذير، والمستندات المسموح بها، وعمليات الاستدعاء) كخصائص إضافية. الحقول التي لا تنطبق على 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). يتم تجاهل المفاتيح غير المعروفة. كل مفتاح اختياري ويحتفظ المفتاح الغائب بقيمته الافتراضية، لذا فإن {} تعني جميع القيم الافتراضية.
مثال:
{}
آخر تعديل في ٧ نوفمبر ٢٠٢٦