Erste Schritte
Integrieren / SDKs
Benutzerverifizierung
Unternehmensverifizierung
Transaktionsüberwachung
ChangelogcURL
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"
}Workflows
Workflow per API erstellen: KYC-Flow aufbauen
Didit-Workflow programmatisch per API erstellen, mit geordneten Funktionen. KYC, KYB, AML und Biometrie in einem Ablauf. Pay-per-Call, keine Verträge.
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"
}
Verwenden Sie diesen Endpoint, um Workflows über die API zu erstellen, ohne selbst Workflow-Graph-Knoten aufzubauen. Senden Sie ein
Die Reihenfolge der Funktionen ist wichtig. Platzieren Sie zum Beispiel
Das genaue
Dieser Graph verwendet
Um auszudrücken, dass NFC aus keinem der bekannten Gründe nicht ausgeführt wurde, verwenden Sie
Jedes konfigurierte Feld wird zu einem verzweigbaren Wert
Ein ungültiger Graph führt zu einer
Der letzte Knoten verwendet
features-Array in der Reihenfolge, in der Benutzer die Prüfungen durchlaufen sollen. Didit wandelt es intern in einen knotenbasierten Workflow um und fügt automatisch den abschließenden Statusschritt hinzu.
Dieser Endpoint POST /v3/workflows/ erstellt nur einfache, lineare Workflows, also eine flache features-Liste. Für Verzweigungen, bedingte Weiterleitung, Document AI sowie Ablehnungs- und Entscheidungsknoten verwenden Sie das Graph-Format, das unten dokumentiert ist. Es bildet die Grundlage für den visuellen Builder in der Konsole und die Workflow-Tools von Didit MCP.
Alle config-Felder, die von den einzelnen Funktionen akzeptiert werden, finden Sie unter Workflow-Funktionskonfigurationen.
Basis-KYC-Workflow
{
"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"
}
]
}
Fragebogen-Workflow
Erstellen Sie zuerst den Fragebogen mitPOST /v3/questionnaires/. Verwenden Sie danach die zurückgegebene questionnaire_id als questionnaire_uuid.
{
"workflow_label": "Source of Funds",
"features": [
{
"feature": "QUESTIONNAIRE",
"config": {
"questionnaire_uuid": "11111111-2222-3333-4444-555555555555",
"review_questionnaire_manually": true
}
}
]
}
OCR vor FACE_MATCH, NFC, DATABASE_VALIDATION oder vor AML-Prüfungen für Benutzer, die auf Dokumentdaten angewiesen sind.
Referenz zur Funktionskonfiguration
Jedes Element infeatures[] hat folgende Struktur:
{
"feature": "OCR",
"label": "ID Verification",
"config": {}
}
config-Objekt hängt von der Funktion ab. Die vollständige Feldliste, Standardwerte, erforderlichen Einstellungen, Wertebereiche und Beispiele finden Sie unter Workflow-Funktionskonfigurationen.
Bei OCR lassen Sie config.documents_allowed weg, senden null oder {}, um jeden unterstützten Dokumenttyp zuzulassen. Geben Sie es nur an, wenn Sie den Workflow auf bestimmte Länder oder Dokumenttypen beschränken möchten. Bei QUESTIONNAIRE ist config.questionnaire_uuid erforderlich.
Optionale Workflow-Einstellungen
Sie können beim Erstellen eines Workflows eines oder mehrere der folgenden Felder auf oberster Ebene angeben, um das Sitzungsverhalten zu steuern. Alle sind optional; werden sie weggelassen, gelten die Standardwerte des Workflows.| Feld | Typ | Beschreibung |
|---|---|---|
is_white_label_enabled | Boolean | Aktiviert die White-Label-Anpassung für Sitzungen, die mit diesem Workflow erstellt werden. Standard false. |
is_desktop_allowed | Boolean | Erlaubt, dass der Verifizierungsablauf in Desktop-Browsern ausgeführt wird. Standard false. |
max_retry_attempts | Ganzzahl (0–10) | Maximale Anzahl an Wiederholungsversuchen nach einer abgelehnten Verifizierung. 0 sperrt den Benutzer nach der ersten Ablehnung. Standard 3. |
retry_window_days | Ganzzahl (1–365) oder null | Gleitendes Zeitfenster in Tagen, mit dem Wiederholungsversuche gezählt werden (null = Limit für die gesamte Zeit). Standard 7. |
session_expiration_time | Ganzzahl (3600–2419200) | Sekunden, nach denen eine nicht abgeschlossene Sitzung abläuft. Minimum 1 Stunde, Maximum 4 Wochen. Standard 604800 (7 Tage). |
response_attributes | Objekt oder null | Begrenzt die Felder, die für jede Funktion zurückgegeben werden, zum Beispiel {"id_verifications": ["full_name", "document_number"], "face_matches": null}. null oder ein fehlender Schlüssel gibt alle Felder zurück. Eine leere Liste gibt nur status, warnings, node_id, is_nfc_skipped und skip_reason zurück; alle anderen Felder werden als null zurückgegeben. |
{
"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" }
]
}
Verzweigungen und knotenbasierte Workflows (Graph)
Eine linearefeatures-Liste kann keine Bedingung der Form „wenn X, dann Y“ abbilden. Für bedingte Verzweigungen (Ablehnung bei einem Status, Weiterleitung anhand eines extrahierten Feldes, Freigabe eines Schritts nur bei einer Übereinstimmung), einen Document-AI-Anforderungsschritt oder terminale Ablehnungs-/Entscheidungsknoten verwenden Didit-Workflows einen Knotengraphen, also dieselbe Struktur, die der visuelle Builder der Konsole erzeugt.
Der einfachste Weg, einen Graph-Workflow zu erstellen, ist das Didit MCP: Bitten Sie einen Agenten in natürlicher Sprache („Wenn nach der Ausweisverifizierung der Beruf ≈ „Software Engineer“ ist, füge einen Kapitalnachweis-Schritt hinzu“). Er erstellt, validiert und speichert den Graphen für Sie. Die folgende Struktur ist das, was diese Tools (und die Konsole) erzeugen.
Graph-Struktur
Ein Graph ist{ start_node, nodes }. nodes ist eine Zuordnung von Knoten-ID zu Knoten. Kanten sind implizit: Jeder Knoten verweist vorwärts über next (unbedingt) und/oder branches[].goto (bedingt).
| Knotentyp | Struktur |
|---|---|
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 (Endknoten) | { "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 muss ein Funktionsknoten sein. Verzweigungen werden der Reihe nach ausgewertet, der erste Treffer gewinnt. Ein leeres rules: [] ist die Auffangregel „else“ (sie steht immer zuletzt). session_status: "Determine" entscheidet automatisch anhand der kombinierten Ergebnisse der Funktionen.
Jeder Verzweigungsknoten muss einen expliziten else-Zweig haben: einen Zweig mit
rules: [], der Sitzungen weiterleitet, auf die keine der Bedingungen zutrifft. Verlassen Sie sich nicht auf das next des Verzweigungsknotens als Ausweichpfad. Ein bloßes next wird im Builder als mehrdeutige Kante dargestellt und wird leicht vergessen. Wenn Sie einen Verzweigungsknoten mit next und ohne else-Zweig senden, wandelt die API dieses next für Sie in einen expliziten else-Zweig um. So wird { …, "branches": [<conditions>], "next": "liveness" } als branches: [<conditions>, { "id": "else", "rules": [], "goto": "liveness" }] gespeichert. Erstellen Sie den else-Zweig selbst, um explizit zu sein. Die Umwandlung ist ein Sicherheitsnetz, kein Ersatz dafür.Verzweigungsregeln und Operatoren
Jede Regel vergleicht ein Feld mit einem Wert über einen Operator:{ "field": "kyc.extra_fields.profession", "operator": "fuzzy_match", "value": "Software Engineer", "score": 80 }
- Felder benennen das Ergebnis einer Funktion (
kyc.status,aml.status,document_ai.status,face_match.score, …) oder einen extrahierten Wert (kyc.full_name,kyc.age,kyc.nationality,kyc.extra_fields.profession, ein Document-AI-Felddocument_ai.<key>,expected_details.*). Eine Verzweigung darf nur ein Feld lesen, dessen Funktion auf jedem Pfad, der zu ihr führt, ausgeführt wurde. - Operatoren:
equals,not_equals,greater_than(_or_equals),less_than(_or_equals),contains,not_contains,in,not_in,is_empty,is_not_empty,regexundfuzzy_match(nur für Zeichenkettenfelder; erfordert einenscorevon 0–100, also einen Ähnlichkeitsschwellenwert, z. B. der Beruf ist zu mindestens 80 % „Software Engineer“ ähnlich).
Verzweigung nach dem Grund, warum NFC nicht ausgeführt wurde
Verwenden Sie nach einemNFC-Knoten nfc.skip_reason mit equals oder in, um Sitzungen danach weiterzuleiten, warum das Auslesen des Chips nicht stattgefunden hat. Das Feld hat diese sieben stabilen Werte:
USER_SKIPPEDDOCUMENT_WITHOUT_CHIPCHIP_CERTIFICATE_UNAVAILABLEDEVICE_WITHOUT_NFCINTEGRATION_WITHOUT_NFC_ACCESSMRZ_KEY_UNAVAILABLEJPKI_UNAVAILABLE
nfc.skip_reason null, sodass weder eine equals- noch eine in-Regel für einen Überspringgrund zutrifft.
Das Feld wird auch für NFC-Knoten aufgelöst, die durch ein Gate übersprungen wurden. Dazu gehören Fälle, in denen kein NFC-Bericht und keine Warnung existiert, sowie Fälle, in denen allow_nfc_skip den Wert false hat, das Dokument- oder Geräte-Gate das Ausführen von NFC aber verhindert. Sie können diese Sitzungen daher weiterleiten, ohne sich auf einen Eintrag nfc_verifications[] zu verlassen.
Sitzungen, die gespeichert wurden, bevor die NFC-Fähigkeit dreiwertig wurde, können
has_device_nfc_support: false haben. Eine ältere Web-Sitzung kann daher zu DEVICE_WITHOUT_NFC statt zu INTEGRATION_WITHOUT_NFC_ACCESS aufgelöst werden.equals für das Überspringen durch den Benutzer, in für das Überspringen aufgrund eines Gates oder fehlender NFC-Fähigkeit und einen expliziten else-Zweig für erfolgreiches NFC. Die Verzweigung folgt auf den NFC-Knoten, und jedes Ziel verweist vorwärts auf einen Endknoten:
{
"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 mit allen sieben Werten. Behalten Sie einen expliziten else-Zweig für erfolgreiches NFC (nfc.skip_reason: null) und für jeden künftigen Wert bei, den Ihr Graph noch nicht kennt.
Document AI (z. B. Kapitalnachweis)
EinDOCUMENT_AI-Funktionsknoten fordert ein oder mehrere Dokumente an und extrahiert benannte Felder:
{
"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>, und das Ergebnis des Schritts ist document_ai.status.
Setzen Sie "is_full_name": true für das Feld, das den vollständigen Namen des Dokumentinhabers enthält. Sein extrahierter Wert wird mit dem vollständigen Namen der verifizierten Identität verglichen (dem Namen aus OCR bzw. der Ausweisverifizierung oder dem vollständigen Namen aus den erwarteten Sitzungsangaben). document_ai_name_mismatch_action legt fest, was bei einer Abweichung unterhalb von document_ai_name_match_score_threshold geschieht. Die Markierung ist optional: Ein Dokument darf kein Feld markieren, und höchstens ein Feld pro Dokument darf sie setzen. Alle Konfigurationsfelder für Document AI finden Sie unter Workflow-Funktionskonfigurationen → Document AI.
Endpoints und Entwurfs-Lebenszyklus
Die Bearbeitung von Graphen erfolgt pro Anwendung über die Konsolen- bzw. Management-Endpoints (Benutzer-Bearer +read:workflows/write:workflows). Ein Graph kann nur in einer Entwurfsversion bearbeitet werden, daher lautet der Lebenszyklus Entwurf erstellen → Graph festlegen → veröffentlichen:
| Methode | Pfad | Zweck |
|---|---|---|
GET | …/verification-settings/{settings_uuid}/workflow-graph/ | Aktueller Graph + status/is_editable |
POST | …/application/{app}/workflow-graph/validate/ (body { "graph": … }) | Trockenlauf-Validierung |
GET | …/application/{app}/workflow-graph/field-definitions/ | Verzweigbare Felder + gültige Operatoren |
POST | …/verification-settings/{settings_uuid}/create-draft/ | Bearbeitbarer Entwurf aus einer veröffentlichten Version |
PUT | …/verification-settings/{settings_uuid}/workflow-graph/ (body { "graph": … }) | Graph speichern |
PATCH | …/verification-settings/{settings_uuid}/ (body { "status": "published" }) | Entwurf veröffentlichen |
Validierungswarnungen
Der Validierungs-Endpoint antwortet mit{ "is_valid": true, "graph": …, "warnings": [] }. Eine Warnung ist rein informativ: Der Graph ist gültig, er wird gespeichert und veröffentlicht, auch wenn Warnungen vorliegen. Jeder Eintrag nennt den Verzweigungsknoten und den Zweig, auf den er sich bezieht, damit ein Ersteller genau die betreffende Bedingung finden kann:
{
"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 | Bedeutung |
|---|---|
branch_outcome_contradiction | Die Bedingung des Zweigs und das Ergebnis, das jeder Pfad von dort erreicht, widersprechen sich, z. B. wenn kyc.status NOT EQUALS Declined in ein Declined-Ergebnis führt. Das Ergebnis kann mehrere Schritte weiter unten im Pfad liegen. |
branch_condition_unreachable | Der Zweig kann nie zutreffen, weil jeder Pfad, der diese Verzweigung erreicht, das Statusfeld bereits auf Werte beschränkt, die die Bedingung ausschließt. |
else_branch_unreachable | Der Else-Zweig kann nie ausgeführt werden: Die übrigen Zweige decken bereits jeden Wert ab, den das Feld hier annehmen kann. |
400-Antwort mit errors und einer nach bestem Bemühen erstellten warnings-Liste. Nur errors verhindern das Speichern.
Praxisbeispiel: Softwareingenieure zum Kapitalnachweis leiten
Nach der Ausweisverifizierung: Wurde sie abgelehnt, lehnen Sie die Sitzung ab; ist der Beruf des Inhabers ≈ “Software Engineer” (≥80% Übereinstimmung), fordern Sie ein Dokument zum Kapitalnachweis an; treffen Sie dann eine abschließende Entscheidung.
{
"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", der automatisch entscheidet (genehmigt / abgelehnt / in Prüfung) anhand der Funktionen, die bei der Sitzung tatsächlich ausgeführt wurden. So werden sowohl der Pfad mit dem Kapitalnachweis als auch der Else-Pfad korrekt aufgelöst, ohne dass ein Zweig document_ai.status liest. Dieses Feld existiert auf dem Pfad nicht, der Document AI überspringt. Beachten Sie: Ein Zweig darf nur ein Feld lesen, dessen Funktion auf jedem Pfad zu ihm ausgeführt wurde.
Senden Sie ihn als { "graph": <above> } an den Endpoint …/workflow-graph/ (validieren Sie zuerst). Um einen neuen Workflow von Grund auf zu erstellen, verwenden Sie didit_workflow_set_graph aus dem MCP. Um einen bestehenden Workflow zu ändern, verwenden Sie didit_workflow_edit_graph (kleine Operationen, die die vorhandenen Knoten und Allow-Listen beibehalten). Siehe Didit MCP.Autorisierungen
Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.
Body
application/json
Erstellen Sie einen einfachen linearen Workflow. Die API wandelt diese Funktionsliste intern in einen knotenbasierten Workflow-Graphen um. STRIKTE Feld-Whitelist: Jeder hier nicht aufgeführte Schlüssel (einschließlich workflow_type) wird mit 400 abgelehnt.
Verifizierungsfunktionen in Ausführungsreihenfolge. Die API verknüpft jedes Element mit dem nächsten und fügt automatisch einen abschließenden Statusknoten hinzu.
Minimum array length:
1Show child attributes
Show child attributes
Anzeigename für den Workflow (max. 50 Zeichen). Standardmäßig "ID Verification", wenn weggelassen – immer angeben, damit Workflows unterscheidbar bleiben.
Maximum string length:
50Beispiel:
"Standard KYC"
Legen Sie diesen Workflow als Standard für neue Sitzungen fest.
Lassen Sie dieses Feld weg, um einen veröffentlichten Workflow zu erstellen, der für Sitzungen bereit ist. Verwenden Sie draft nur, wenn Sie speichern möchten, ohne zu veröffentlichen.
Verfügbare Optionen:
draft, published White-Label-Anpassung für Sitzungen aktivieren, die mit diesem Workflow erstellt wurden.
Ermöglicht die Ausführung des Verifizierungs-Workflows in Desktop-Browsern.
Maximale Anzahl an Wiederholungsversuchen, die nach einer abgelehnten Verifizierung zulässig sind. 0 blockiert den Benutzer nach der ersten Ablehnung.
Erforderlicher Bereich:
0 <= x <= 10Gleitendes Zeitfenster in Tagen zur Zählung der Wiederholungsversuche. null erzwingt ein Limit für den gesamten Zeitraum.
Erforderlicher Bereich:
1 <= x <= 365Maximale Anzahl an Liveness-Übermittlungen pro Sitzung. Standardwert 3: ein erster Versuch plus zwei Wiederholungsversuche. Dieser Wert wird auch in generierte Liveness- und Altersschätzungs-Workflow-Knoten kopiert, sofern er nicht durch die Konfiguration auf Funktionsebene überschrieben wird.
Erforderlicher Bereich:
1 <= x <= 3Maximale Anzahl an Gesichtsabgleich-Übermittlungen pro Sitzung. Standardwert 3: ein erster Versuch plus zwei Wiederholungsversuche. Dieser Wert wird auch in generierte Gesichtsabgleich-Workflow-Knoten kopiert, sofern er nicht durch die Konfiguration auf Funktionsebene überschrieben wird.
Erforderlicher Bereich:
1 <= x <= 3Sekunden, bis eine nicht abgeschlossene Sitzung abläuft. Mindestens 1 Stunde (3600), maximal 4 Wochen (2419200).
Erforderlicher Bereich:
3600 <= x <= 2419200Antwort
Workflow erstellt. Der Antwort-Body enthält die VOLLSTÄNDIGE Workflow-Konfiguration – dieselbe unveränderte VerificationSettings-Serialisierung, die von GET /v3/workflows/{settings_uuid}/ zurückgegeben wird (~190 Felder: jede Funktionseinstellung, Schwellenwert, jede Aktion und der generierte workflow_graph), nicht das kompakte Listenelement. Speichern Sie die uuid (auch als workflow_id bereitgestellt), damit Sie bei späteren Aufrufen zur Sitzungserstellung darauf verweisen können. Hinweis: features ist ein mit " + " verknüpfter String und Preise sind JSON-Zahlen.
Die folgenden Felder sind typisiert; das Objekt enthält außerdem jede andere Spalte der Workflow-Konfiguration (Funktionsschalter, Schwellenwerte, Warnungsaktionen, zulässige Dokumente, Callbacks) als zusätzliche Eigenschaften. Felder, die für den workflow_type nicht gelten, sind null.
Versionsspezifische Kennung (settings_uuid). Jede Version eines Workflows hat ihre eigene.
Stabiler Identifikator, der von jeder Version des Workflows geteilt wird. Damit erstellte Sitzungen verwenden die neueste veröffentlichte Version.
Anzeigename des Workflows.
Workflow-Vorlage. null für Graph-Workflows, die ohne Vorlage erstellt wurden.
Verfügbare Optionen:
kyc, kyb, adaptive_age_verification, biometric_authentication, address_verification, questionnaire_verification, email_verification, phone_verification, null Gibt an, ob dies der Standard-Workflow der Anwendung ist.
Archivierte Workflows können keine neuen Sitzungen starten.
Versionsnummer innerhalb des Workflows.
Entwurfsversionen können bearbeitet werden; veröffentlichte Versionen sind unveränderlich und werden für neue Sitzungen verwendet.
Verfügbare Optionen:
draft, published Wann diese Version veröffentlicht wurde. null für Entwürfe.
true, wenn der Workflow keinen benutzerdefinierten workflow_graph hat.
true nur für draft-Versionen.
Öffentliche URL, die eine Sitzung mit diesem Workflow startet.
Graphstruktur des Workflows (Knoten und Kanten). null für einfache Workflows.
Aktivierte Funktionen, verbunden mit " + ", zum Beispiel "OCR + LIVENESS".
Preis pro Sitzung; bei Graph-Workflows der teuerste Pfad.
Preis des günstigsten Pfads durch den Workflow.
Preis des teuersten Pfads durch den Workflow.
Organisationsspezifische Zusatzpreise oder null, wenn keine festgelegt sind.
Zulässige Wiederholungsversuche nach einer abgelehnten Verifizierung.
Tage, während derer Wiederholungsversuche zulässig sind.
Sekunden, bis eine nicht abgeschlossene Sitzung abläuft.
Der an den Workflow angehängte Fragebogen oder null.
Verifizierungseinstellungen pro Rolle für KYB-Schlüsselpersonen.
Welche E-Signatur-Stufen derzeit signieren können. Prüfen Sie dies, bevor Sie signature_level festlegen. Wird bei kyc-, kyb- und Graph-Workflows zurückgegeben.
Show child attributes
Show child attributes
Gibt an, ob ein einfacher KYC- oder KYB-Workflow die Bankverifizierung ausführt. Sie läuft nach den Kontaktschritten (und der Standortverifizierung) sowie vor der Datenbankvalidierung, AML und IP-Analyse. Die Bankverifizierung ist noch nicht allgemein verfügbar: Ihre Aktivierung wird überall abgelehnt, wo sie nicht freigeschaltet ist.
Bankverifizierungseinstellungen eines einfachen Workflows mit denselben Schlüsseln, die ein BANK_VERIFICATION-Knoten akzeptiert (z. B. bank_countries und bank_method_order). Unbekannte Schlüssel werden verworfen. Jeder Schlüssel ist optional, und ein fehlender Schlüssel behält seinen Standardwert bei, sodass {} für alle Standardwerte steht. Siehe Bankverifizierungseinstellungen.
Beispiel:
{}
Gibt an, ob ein einfacher KYC-Workflow die Standortverifizierung ausführt. Sie läuft nach den Kontaktschritten sowie vor der Bankverifizierung und Datenbankvalidierung. Unternehmens-Workflows (KYB) können sie nicht ausführen.
Standortverifizierungs-Einstellungen eines einfachen Workflows mit denselben Schlüsseln, die ein GEOLOCATION-Knoten akzeptiert (zum Beispiel is_geolocation_geofencing_enabled und geolocation_max_attempts). Unbekannte Schlüssel werden verworfen. Jeder Schlüssel ist optional und ein fehlender Schlüssel behält seinen Standardwert, sodass {} alle Standardwerte bedeutet.
Beispiel:
{}
Zuletzt geändert am 7. November 2026