Zum Hauptinhalt springen
GET
cURL

Autorisierungen

x-api-key
string
header
erforderlich

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.

Pfadparameter

settings_uuid
string<uuid>
erforderlich

Versionsspezifische UUID des Workflows (der vom Listen-Endpoint zurückgegebene uuid-Wert). Jede Version eines Workflows hat ihre eigene settings_uuid.

Antwort

Vollständige Workflow-Konfiguration. Die Struktur entspricht der rohen VerificationSettings-Serialisierung (~190 Felder: jeder Feature-Toggle, Schwellenwert, jede Warnungsaktion, Konfiguration zulässiger Dokumente, der workflow_graph, Wiederholungsrichtlinie, Callbacks und Preise). Das nachfolgende Beispiel ist gekürzt. Hinweise: features ist ein mit " + " verbundener String (z. B. "OCR + LIVENESS"), Preise sind JSON-Zahlen und is_editable ist nur für draft-Versionen true.

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.

uuid
string<uuid>

Versionsspezifische Kennung (settings_uuid). Jede Version eines Workflows hat ihre eigene.

workflow_id
string<uuid>

Stabiler Identifikator, der von jeder Version des Workflows geteilt wird. Damit erstellte Sitzungen verwenden die neueste veröffentlichte Version.

workflow_label
string

Anzeigename des Workflows.

workflow_type
enum<string> | null

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
is_default
boolean

Gibt an, ob dies der Standard-Workflow der Anwendung ist.

is_archived
boolean

Archivierte Workflows können keine neuen Sitzungen starten.

version
integer

Versionsnummer innerhalb des Workflows.

status
enum<string>

Entwurfsversionen können bearbeitet werden; veröffentlichte Versionen sind unveränderlich und werden für neue Sitzungen verwendet.

Verfügbare Optionen:
draft,
published
published_at
string<date-time> | null

Wann diese Version veröffentlicht wurde. null für Entwürfe.

is_simple_workflow
boolean

true, wenn der Workflow keinen benutzerdefinierten workflow_graph hat.

is_editable
boolean

true nur für draft-Versionen.

workflow_url
string<uri>

Öffentliche URL, die eine Sitzung mit diesem Workflow startet.

workflow_graph
object | null

Graphstruktur des Workflows (Knoten und Kanten). null für einfache Workflows.

features
string

Aktivierte Funktionen, verbunden mit " + ", zum Beispiel "OCR + LIVENESS".

total_price
number | null

Preis pro Sitzung; bei Graph-Workflows der teuerste Pfad.

min_price
number | null

Preis des günstigsten Pfads durch den Workflow.

max_price
number | null

Preis des teuersten Pfads durch den Workflow.

special_add_on_prices
object | null

Organisationsspezifische Zusatzpreise oder null, wenn keine festgelegt sind.

max_retry_attempts
integer

Zulässige Wiederholungsversuche nach einer abgelehnten Verifizierung.

retry_window_days
integer | null

Tage, während derer Wiederholungsversuche zulässig sind.

session_expiration_time
integer

Sekunden, bis eine nicht abgeschlossene Sitzung abläuft.

questionnaire
object | null

Der an den Workflow angehängte Fragebogen oder null.

kyb_role_settings
object[]

Verifizierungseinstellungen pro Rolle für KYB-Schlüsselpersonen.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

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.

is_bank_verification_enabled
boolean

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.

bank_verification_config
object

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:
is_geolocation_enabled
boolean

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.

geolocation_config
object

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