Zum Hauptinhalt springen
PATCH
curl

Was dieser Endpoint bewirkt

Eine Verifizierungssitzung besteht aus einzelnen Funktionen (Schritten): ID/OCR, Liveness, Gesichtsabgleich, AML, Adressnachweis, Telefon usw. Mit diesem Endpoint setzen Sie den Status eines dieser Schritte auf Approved, Declined oder In Review. Verwenden Sie update-status, wenn Sie die gesamte Sitzung genehmigen, ablehnen oder erneut öffnen möchten. Verwenden Sie diesen Endpoint, wenn Sie nur eine Entscheidung für einen einzelnen Schritt festhalten möchten, zum Beispiel um den Schritt Gesichtsabgleich für Ihren eigenen Prüfablauf als Declined zu markieren. Eine Sitzung, die bereits eine Entscheidung hat, behält diese: Nur der Schritt ändert sich. Hat die Sitzung noch keine Entscheidung und wartet ihr Workflow genau auf diesen Schritt, schließt die Überschreibung den Schritt ab, so wie es der normale Abschluss täte. Der Workflow läuft weiter, spätere Schritte werden ausgeführt, und ein Status-Knoten kann die Sitzungsentscheidung setzen und einen Webhook status.updated auslösen.

Einen Schritt mit node_id ansteuern

In graphbasierten Workflows hat jeder Schritt eine node_id (zum Beispiel feature_ocr_1, feature_liveness_1, feature_aml_1). Sie finden diese in der Sitzungsentscheidung: Jede Funktion in einer V3-Entscheidung enthält ihre node_id. Bei nicht graphbasierten (einschrittigen) Workflows hat die zugrunde liegende Funktion keine Knoten-ID. Übergeben Sie den wörtlichen Wert default als nodeId, um sie anzusteuern. Da kein Schritt eines solchen Workflows eine Knoten-ID hat, übergeben Sie außerdem feature_type (zum Beispiel LIVENESS, AML oder FACE_MATCH), um anzugeben, welchen Schritt Sie meinen. Ein unbekannter feature_type liefert 400 zurück.

Bis zum Abschluss des Ablaufs warten

Standardmäßig wird die Überschreibung sofort angewendet. Befindet sich die Person noch im Ablauf, wird damit ein Schritt in einem noch laufenden Ablauf geändert; die Überschreibung wird dann mit forced: true erfasst. Setzen Sie defer_until_flow_finishes: true, um stattdessen zu warten. Solange die Sitzung Not Started, In Progress oder Resubmitted ist und die Person den Ablauf nicht abgeschlossen hat, wird die Überschreibung als pending_until_flow_finishes gespeichert. Sie wird angewendet, wenn die Person den Ablauf abschließt, nachdem der Ablauf seine eigene Entscheidung getroffen hat. Bei einer Sitzung, deren Ablauf bereits beendet ist, wird sie in beiden Fällen sofort angewendet. Eine wartende Überschreibung wird abgebrochen, anstatt angewendet zu werden, wenn:
  • die Person den Schritt vor dem Abschluss erneut durchläuft (check_changed),
  • eine neuere Überschreibung desselben Schritts sie ersetzt (replaced),
  • die Sitzung den Ablauf unvollständig verlässt: abgebrochen, abgelaufen oder mitten im Ablauf entschieden (session_closed),
  • Sie sie mit Funktionsüberschreibung abbrechen abbrechen (cancelled_by_reviewer).
Das Feld override in der Antwort gibt an, was passiert ist: state ist applied oder pending_until_flow_finishes, und applied_at ist gesetzt, sobald die Überschreibung angewendet wurde. Der Wert new_status auf oberster Ebene ist der gespeicherte Status des Schritts und bleibt daher unverändert, solange die Überschreibung wartet. Mit Funktionsüberschreibungen auflisten sehen Sie jede Überschreibung einer Sitzung und ob sich die Person noch im Ablauf befindet.

Unterstützung für KYC und KYB

Funktioniert identisch für Sitzungen der Benutzerverifizierung (KYC) und der Unternehmensverifizierung (KYB). Didit löst die sessionId für beide auf. Unterstützte Schritttypen sind ID/OCR, Liveness, Gesichtsabgleich, NFC, AML, Adressnachweis, Telefon, E-Mail, Datenbankvalidierung, Fragebogen sowie die Prüfungen des KYB-Unternehmensregisters, der Dokumente und der Schlüsselpersonen.
Eigenständige API-Sitzungen (also solche, die über die eigenständigen Verifizierungs-APIs erstellt wurden, session_type = API) können keine einzelnen Funktionsstatus geändert werden. Der Endpoint liefert in diesem Fall 400 zurück.

Beispiele

Was nach einer Aktualisierung passiert

  • Webhook: Ein Ereignis data.updated wird ausgelöst, sobald die Überschreibung angewendet wird, sofort oder wenn der Ablauf endet. Während sie wartet oder wenn sie abgebrochen wird, wird nichts gesendet.
  • Aktivität: Jede Überschreibung wird in der Aktivität der Sitzung als FEATURE_OVERRIDE_PENDING, FEATURE_OVERRIDE_APPLIED oder FEATURE_OVERRIDE_CANCELLED erfasst, mit dem Akteur (API-Schlüssel, Benutzer oder das System, wenn eine wartende Überschreibung angewendet wird). Der Eintrag der Anfrage enthält Ihren comment als Begründung. Im Array reviews der Sitzungsentscheidung erscheinen diese Einträge mit new_status: null, und der Eintrag der Anfrage hat Ihre Begründung in comment.
  • Sitzungsentscheidung: Eine Sitzung, die bereits eine Entscheidung hat, behält sie. Um die endgültige Entscheidung zu ändern, rufen Sie separat update-status auf.

Berechtigung

Erforderlich ist die Berechtigung write:sessions, entweder mit einem Client-API-Schlüssel (x-api-key) oder mit einem Benutzer-Autorisierungsheader. Ein API-Schlüssel mit eingeschränktem Umfang benötigt Schreibzugriff auf Entscheidungen.

Verwandte Themen

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

sessionId
string<uuid>
erforderlich

UUID der Verifizierungssitzung. Akzeptiert sowohl Benutzer- (KYC) als auch Unternehmens- (KYB) Sitzungs-IDs — der Dienst löst die ID über beide Sitzungstypen hinweg auf.

Beispiel:

"11111111-2222-3333-4444-555555555555"

nodeId
string
erforderlich

Workflow-Graph-Knoten-ID der zu aktualisierenden Funktion (beispielsweise feature_ocr_1). Verwenden Sie den literalen Wert default für Nicht-Graph-Workflows (Einzelschritt-Workflows), bei denen die Funktion keine Knoten-ID besitzt.

Beispiel:

"feature_ocr_1"

Body

application/json
new_status
enum<string>
erforderlich

Zielstatus für diese Funktion. Muss vom aktuellen Wert abweichen.

Verfügbare Optionen:
Approved,
Declined,
In Review
Beispiel:

"Approved"

comment
string

Optionale Freitextnotiz, die im Prüfungsprotokoll der Sitzung für diese Funktionsänderung aufgezeichnet wird.

Beispiel:

"Document manually verified by compliance."

feature_type
enum<string>

Auf welche Art von Schritt abgezielt werden soll. Erforderlich bei Nicht-Graph-Workflows (nodeId = default), bei denen die Schritte keinen gemeinsamen Knoten haben; andernfalls optional. Ein unbekannter Wert gibt 400 zurück.

Verfügbare Optionen:
ID_VERIFICATION,
OCR,
OCR_BACK,
NFC,
LIVENESS,
FACE,
AGE_ESTIMATION,
AGE_VERIFICATION,
FACE_SEARCH,
FACE_MATCH,
IP_ANALYSIS,
AML,
PHONE,
PHONE_VERIFICATION,
EMAIL,
EMAIL_VERIFICATION,
POA,
PROOF_OF_ADDRESS,
DATABASE_VALIDATION,
DATA_VALIDATION,
QUESTIONNAIRE,
DOCUMENT_AI,
KYB_REGISTRY,
KYB_DOCUMENTS,
KYB_KEY_PEOPLE,
BANK_VERIFICATION,
GEOLOCATION
Beispiel:

"LIVENESS"

defer_until_flow_finishes
boolean
Standard:false

Solange sich die Person noch im Ablauf befindet, wird die Überschreibung als pending_until_flow_finishes gespeichert und angewendet, sobald der Ablauf beendet ist, anstatt sofort. Wenn weggelassen oder false, wird die Überschreibung sofort angewendet. Bei einer Sitzung, deren Ablauf bereits beendet ist, wird sie in jedem Fall sofort angewendet.

Beispiel:

false

Antwort

Der Override wurde erfasst. new_status ist der gespeicherte Status der Prüfung: der angeforderte, sobald der Override angewendet wurde, der unveränderte, während er auf den Abschluss des Ablaufs wartet. override gibt an, was eingetreten ist.

session_id
string<uuid>
erforderlich
node_id
string | null
erforderlich

Der Workflow-Knoten des aktualisierten Schritts oder null für einen Schritt ohne Knoten (der default-Pfad in einem Workflow ohne Graph).

Beispiel:

"feature_ocr_1"

feature_type
string
erforderlich

Modellname der aktualisierten Funktion (z. B. KYC, Face, FaceMatch, AML, POA).

Beispiel:

"KYC"

new_status
string
erforderlich

Der gespeicherte Status der Überprüfung: der angefragte, sobald der Override angewendet wurde; der unveränderte, während der Override auf den Abschluss des Workflows wartet.

Beispiel:

"Approved"

override
object
erforderlich

Eine Überschreibung eines Prüfungs- bzw. Funktionsstatus, vorgenommen mit PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/: was geändert wird, ob sie angewendet wurde oder noch darauf wartet, dass die Person den Flow abschließt, wer die Anfrage gestellt hat und warum.

Zuletzt geändert am 7. November 2026