Alle vier Endpoints akzeptieren Ihren API-Schlüssel oder einen Benutzer-Autorisierungs-Header, und alle vier senden bei Erfolg ein
data.updated-Webhook, damit Ihr System und Ihre nachgelagerten Analysen synchron bleiben.
Gemeinsame Anforderungen
- Autorisierung: API-Schlüssel (standardmäßiger
x-api-key- bzw.Authorization-Bearer) oder Benutzer-Autorisierungstoken. - Berechtigung:
- KYC und POA:
write:sessions - KYB-Unternehmensdaten und Schlüsselpersonen-Partei:
write:businesses
- KYC und POA:
- Sitzungsstatus (nur KYC / POA): muss einer der folgenden Werte sein:
APPROVED,DECLINED,IN_REVIEWoderKYC_EXPIRED. Sitzungen, die noch keinen prüfbaren Zustand erreicht haben, können nicht geändert werden. Für KYB-Unternehmensaktualisierungen gibt es keine Statusbeschränkung. - Datensatz der Funktion muss vorhanden sein: KYC-Felder können nur geändert werden, wenn die Sitzung ein KYC erfasst hat, POA-Felder nur, wenn sie einen POA erfasst hat, und KYB-Unternehmensfelder nur, wenn die Sitzung eine Prüfung des Unternehmensregisters enthält.
- Teilaktualisierungen: Nur die Felder, die Sie senden, werden geändert. Lassen Sie ein Feld weg, bleibt es unverändert. Senden Sie
null, um einenextra_fields-Schlüssel zu entfernen. - Webhooks: Eine erfolgreiche Aktualisierung löst
data.updatedmitsession_kind: "user"oder"business"aus. Im Audit-Log der Sitzung wird festgehalten, welche konkreten Felder geändert wurden und wer die Änderung vorgenommen hat.
KYC-Identitätsdaten aktualisieren
PATCH /v3/session/{sessionId}/update-data/
Sie können jedes aus dem Ausweisdokument extrahierte Feld korrigieren. Graphbasierte Workflows mit mehreren Instanzen werden unterstützt: Über den optionalen Query-Parameter oder das Body-Feld node_id wählen Sie gezielt einen KYC-Datensatz aus, wenn eine einzelne Sitzung mehrere KYC-Schritte hat.
Änderbare Felder
parsed_address akzeptiert nur diese verschachtelten Schlüssel: address_type, city, region, street_1, street_2, postal_code, country (ISO 3166-1 alpha-2).
Beispiel
?node_id=feature_ocr_2 zur URL hinzu (oder übergeben "node_id": "feature_ocr_2" im Body), um gezielt einen KYC-Datensatz anzusprechen.
Adressnachweis-Daten (POA) aktualisieren
PATCH /v3/session/{sessionId}/update-poa-data/
Sie können Felder korrigieren, die aus einem Adressnachweis extrahiert wurden. Es gelten dieselben Statusbeschränkungen und Berechtigungen wie für KYC-Aktualisierungen. Auch hier wird node_id für Workflows mit mehreren Instanzen unterstützt.
Änderbare Felder
Beispiel
KYB-Unternehmensdaten aktualisieren
PATCH /v3/session/{sessionId}/kyb/{companyUuid}/update-data/
Korrigieren Sie die aus dem Register übernommenen Felder eines KYB-Unternehmens. Der Endpoint bearbeitet sowohl die kanonischen Unternehmensspalten als auch registry_data, sodass die Ansicht „Extracted from Registry“ in der Konsole Ihre Korrekturen anzeigt. user_provided_data (was der Endbenutzer im gehosteten Ablauf bestätigt hat) wird nicht verändert. last_console_edit_at wird gesetzt, und ein data.updated-Webhook wird mit trigger: "console_registry_edit" ausgelöst.
Voraussetzungen
- Berechtigung:
write:businesses(unterscheidet sich von der Berechtigung für KYC und Adressnachweis). - Die
companyUuidin der URL muss zur angegebenensessionIdgehören, andernfalls erhalten Sie einen 404-Fehler. - Keine Statusprüfung der Sitzung: Die KYB-Unternehmensdaten können jederzeit korrigiert werden.
Änderbare Felder
Ein weggelassenes Feld bleibt unverändert. Jedes gesendete Feld wird in die kanonische Spalte geschrieben (sofern eine existiert) und in
registry_data zusammengeführt. Beim Zusammenführen in registry_data werden Datumswerte als ISO-8601-Strings serialisiert.
Beispiel
registry_checks[].company in der Sitzungsentscheidung.
Eine Partei der Schlüsselpersonen überspringen
PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/
Befreien Sie eine Partei der Schlüsselpersonen von der Verifizierung. Dies ist der Notausgang für eine Partei, deren eigene Prüfung nie abgeschlossen werden kann. Die übliche Ursache ist eine gelöschte untergeordnete Sitzung: Sobald die einzelne KYC-Sitzung, die einem UBO oder Geschäftsführer zugewiesen wurde, gelöscht ist, ist ihr Status eingefroren und kann nie einen endgültigen Status erreichen. Das KYB hat dann nichts mehr, was es aus Awaiting User herausbewegen könnte. Das Überspringen der Partei nimmt sie aus der Aggregation der Schlüsselpersonen heraus, die Prüfung wird sofort neu berechnet, und die Sitzung kann abgeschlossen sowie genehmigt oder abgelehnt werden.
Voraussetzungen
- Berechtigung:
write:businesses. - Die
partyUuidin der URL muss zur angegebenensessionIdgehören, andernfalls erhalten Sie einen 404-Fehler. - Nicht durch
allow_skipeingeschränkt. Diese Rollen-Einstellung begrenzt, was der Antragsteller beim Ausfüllen des gehosteten Bildschirms für Schlüsselpersonen überspringen darf. Dieser Endpoint ist die vom Betreiber vorgenommene Überschreibung und funktioniert daher auch bei Rollen, die der Antragsteller nicht hätte überspringen können.
Body
requires_verification bleibt bewusst unverändert. Eine überschriebene Partei erscheint daher mit requires_verification: true und is_skipped: true. So zeigt der Datensatz weiterhin an, dass die Regeln eine Prüfung verlangt haben.
Beispiel
key_people_checks[].submitted.parties[] in der Sitzungsentscheidung.
Ein data.updated-Webhook wird mit trigger: "console_key_people_skip" ausgelöst.
Eine Partei, deren untergeordnete Sitzung gelöscht wurde, ist in der Entscheidungs-Payload mit
kyc_session_deleted: true (bzw. kyb_sub_session_deleted: true bei juristischen Personen) markiert.
Ihre kyc_session_url bzw. kyb_sub_session_url wird als null zurückgegeben, weil der Link nicht mehr aufgelöst werden kann.
Das Löschen einer untergeordneten Sitzung genehmigt die Partei nie allein: Die Prüfung der Schlüsselpersonen wechselt auf In Review, damit eine Person die Entscheidung trifft.Was nach einer Aktualisierung passiert
- Webhook:
data.updatedwird für die Sitzung ausgelöst, wobei die Payload dassession_kindder Sitzung enthält ("user"oder"business"). Abonnieren Sie ihn einmal auf Ziel-Ebene und leiten Sie anhand vonsession_kindweiter. - Audit-Log: Die Sitzung protokolliert genau, welche Felder sich geändert haben, die bisherigen und neuen Werte und (bei Aufrufen mit Benutzerauthentifizierung) die E-Mail-Adresse des Akteurs. Sichtbar im Events-Tab der Konsole.
- Erneutes Geocoding der Adresse: Bei KYC- und Adressnachweis-Aktualisierungen, die
addressbzw.poa_addressändern, führt Didit das Geocoding im Hintergrund erneut aus. Fehler werden stillschweigend ignoriert, sodass eine Aktualisierung nie wegen eines Geocoding-Problems fehlschlägt. - Erneutes AML-Screening: KYC-Aktualisierungen, die Name, Geburtsdatum oder Staatsangehörigkeit ändern, können ein erneutes AML-Screening auslösen, sofern das AML-Screening für die Sitzung noch nicht abgeschlossen war. Die Ergebnisse erscheinen in der Sitzungsentscheidung.
Wann Sie diese Endpoints nicht verwenden sollten
- Gesamte Verifizierung erneut durchführen: Muss der Kunde sein Ausweisfoto erneut aufnehmen oder ein Dokument erneut hochladen, verwenden Sie update-status, um die Sitzung auf
Resubmittedzu setzen. - Profilfelder der Entität User oder Business ändern: Verwenden Sie
PATCH /v3/users/{vendor_data}/oderPATCH /v3/businesses/{vendor_data}/. Diese Endpoints aktualisieren Daten auf Entitätsebene, nicht Daten auf Sitzungsebene. - Details zu den Schlüsselpersonen bearbeiten: Es gibt keine öffentliche API, um Name, Rollen oder Eigentumsverhältnisse einer Partei zu ändern; diese Daten werden über den gehosteten Ablauf übermittelt. Das einzige änderbare Feld ist
is_skipped(siehe Eine Partei der Schlüsselpersonen überspringen).
Fehler
Nächste Schritte
Sitzung abrufen
Rufen Sie die vollständige Entscheidung ab, um die aktualisierten Felder zu sehen.
Status aktualisieren
Genehmigen, ablehnen oder eine Sitzung nach einer Datenkorrektur erneut öffnen.
Webhooks
Abonnieren Sie Webhook-Ereignisse vom Typ
data.updated.