Zum Hauptinhalt springen
PATCH
cURL
Verwenden Sie PATCH für partielle Aktualisierungen. Um einen Workflow umzubenennen, senden Sie nur workflow_label.
Um die Prüfungen im Workflow zu ändern, senden Sie das vollständige gewünschte features-Array. Dadurch werden die bisherige Reihenfolge der Funktionen und deren Konfiguration ersetzt.
Die v3-API hält Workflows einfach: einen linearen Pfad und einen abschließenden Statusschritt. Verzweigungen, Aktionsknoten und Webhook-Knoten werden hier nicht akzeptiert.

Referenz der Funktionskonfiguration

Wenn Sie features in einem PATCH senden, ersetzt das Array die bisherige Reihenfolge der Funktionen und deren Konfiguration. Geben Sie jede erforderliche Konfiguration erneut an. Das genaue config-Objekt hängt von der Funktion ab. Die vollständige Feldliste, Standardwerte, erforderlichen Einstellungen, Wertebereiche und Beispiele finden Sie unter Konfigurationen der Workflow-Funktionen. Für OCR lassen Sie config.documents_allowed weg, senden null oder senden {}, um alle unterstützten Dokumenttypen zuzulassen. Geben Sie es nur an, wenn Sie den Workflow auf bestimmte Länder oder Dokumenttypen beschränken möchten. Für QUESTIONNAIRE ist config.questionnaire_uuid erforderlich.

Workflow-Einstellungen aktualisieren

Sie können sitzungsbezogene Einstellungen aktualisieren, ohne die Funktionsliste zu ändern. Senden Sie nur die Felder, die Sie ändern möchten.
Verwenden Sie die uuid des Workflows, die der Listen-, Erstellungs- oder Abruf-Endpoint zurückgibt, als settings_uuid in dieser URL.

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 zu aktualisierenden Workflows.

Body

application/json

Workflow-Metadaten aktualisieren oder die gesamte lineare Liste der Funktionen ersetzen. STRIKTE Feld-Whitelist: Jeder hier nicht aufgeführte Schlüssel wird mit 400 abgewiesen.

workflow_label
string

Anzeigename für den Workflow (max. 50 Zeichen).

Maximum string length: 50
is_default
boolean

Legen Sie diesen Workflow als Standard für neue Sitzungen fest.

status
enum<string>

Steuert die Versionierung. Weglassen, um die aktuelle Version direkt zu aktualisieren (Entwürfe werden automatisch veröffentlicht). published bei einer bereits veröffentlichten Version erstellt und gibt eine NEUE Version zurück. draft ist nur gültig, solange die Version noch ein Entwurf ist.

Verfügbare Optionen:
draft,
published
features
object[]

Falls angegeben, ersetzt dies die vollständige Funktionsreihenfolge und -konfiguration.

Minimum array length: 1
is_white_label_enabled
boolean

White-Label-Anpassung für Sitzungen aktivieren, die mit diesem Workflow erstellt wurden.

is_desktop_allowed
boolean

Ermöglicht die Ausführung des Verifizierungs-Workflows in Desktop-Browsern.

max_retry_attempts
integer

Maximale Anzahl an Wiederholungsversuchen, die nach einer abgelehnten Verifizierung zulässig sind. 0 blockiert den Benutzer nach der ersten Ablehnung.

Erforderlicher Bereich: 0 <= x <= 10
retry_window_days
integer | null

Gleitendes Zeitfenster in Tagen zur Zählung der Wiederholungsversuche. null erzwingt ein Limit für den gesamten Zeitraum.

Erforderlicher Bereich: 1 <= x <= 365
face_liveness_max_attempts
integer

Maximale Anzahl an Liveness-Übermittlungen pro Sitzung. 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 <= 3
face_match_max_attempts
integer

Maximale Anzahl an Gesichtsabgleich-Übermittlungen pro Sitzung. Dieser Wert wird auch in generierte Gesichtsabgleich-Workflow-Knoten kopiert, sofern er nicht durch die Konfiguration auf Funktionsebene überschrieben wird.

Erforderlicher Bereich: 1 <= x <= 3
session_expiration_time
integer

Sekunden, bis eine nicht abgeschlossene Sitzung abläuft. Mindestens 1 Stunde (3600), maximal 4 Wochen (2419200).

Erforderlicher Bereich: 3600 <= x <= 2419200

Antwort

Workflow aktualisiert. Der Body ist die VOLLSTÄNDIGE Konfiguration der resultierenden Version (dieselbe Rohform von VerificationSettings wie bei GET /v3/workflows/{settings_uuid}/). Wenn die Aktualisierung eine neue Version erstellt hat (status: "published" bei einer veröffentlichten Zeile gesendet), weichen die zurückgegebenen Werte für uuid und version von denen ab, die Sie gepatcht haben — verwenden Sie die zurückgegebene uuid für nachfolgende Aufrufe.

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