Zum Hauptinhalt springen
PATCH
curl

Übersicht

Aktualisiert änderbare Felder einer Benutzer-Entität. Felder, die aus verifizierten Sitzungen der Benutzerverifizierung (KYC) übernommen werden (full_name, date_of_birth, portrait_image, aggregierte Zähler, features), sind schreibgeschützt.

Wann man es verwendet

  • Eigene Metadaten aktualisieren: Einen Benutzer in eine andere Stufe verschieben, Tags ändern oder eine interne Notiz hinterlegen.
  • Umbenennen: Einen besseren display_name für interne Ansichten in der Console festlegen.
  • Verifizierte Daten überschreiben (mit Vorsicht): Manuelle Überschreibungen sind zulässig, werden aber im Audit-Log protokolliert.

Hinweise

  • vendor_data in der URL kann über diesen Endpoint nicht geändert werden. Wenn Sie den Schlüssel ändern müssen, legen Sie einen neuen Benutzer an und löschen Sie den alten.
  • Sendet einen Webhook user.data.updated mit einem Array changed_fields, damit Empfänger ihre Daten effizient synchronisieren können.
  • Eine Änderung von status über diesen Endpoint funktioniert wie Benutzerstatus aktualisieren. Sie wird in der Aktivität der Person erfasst, mit dem optionalen reason (bis zu 1000 Zeichen) als Kommentar. Bei BLOCKED wird der vendor_data zur Systemsperrliste hinzugefügt. Der Webhook user.status.updated enthält kein reason.
  • Wenn Sie ein Feld per PATCH ändern, das gerade von einer verifizierten Sitzung verwaltet wird, wird die Überschreibung akzeptiert, aber im Audit-Log markiert.

Berechtigungen

Der primäre geheime Schlüssel und API-Schlüssel mit vollem Zugriff können diesen Endpoint immer aufrufen. Ein API-Schlüssel mit benutzerdefiniertem Zugriff benötigt Schreibzugriff auf Personen (users). Ein Schlüssel, der auf bestimmte Workflows oder auf genehmigte Sitzungen beschränkt ist, kann diesen Endpoint nicht aufrufen. Die Rollen und Berechtigungen der Console legen fest, was ein Teammitglied in der Console tun darf. Sie werden für API-Schlüssel-Anfragen nicht ausgewertet.

Verwandte Seiten

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

vendor_data
string
erforderlich

Ihre eindeutige Kennung für den Benutzer (Freitext-String, KEINE UUID).

Body

application/json
full_name
string | null

Vollständiger Name des Benutzers

Maximum string length: 512
display_name
string | null

Benutzerdefinierter Anzeigename für diesen Benutzer

date_of_birth
string<date> | null

Geburtsdatum im Format JJJJ-MM-TT

status
enum<string>

Lebenszyklusstatus des Benutzers. Eine Änderung wird als STATUS_CHANGED-Aktivität erfasst, und BLOCKED fügt die vendor_data zur System-Sperrliste hinzu (das Verlassen von BLOCKED entfernt diesen Eintrag wieder).

Verfügbare Optionen:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Beliebiges JSON-Objekt, das Sie an den Benutzer anhängen. Ersetzt vollständig die vorhandenen Metadaten bei einer Aktualisierung – führen Sie diese clientseitig zusammen, wenn Sie nur Schlüssel hinzufügen möchten.

approved_emails
string[]

Verifizierte E-Mail-Adressen für diesen Benutzer, z. B. ["john@example.com"]. Ersetzt die gespeicherte Liste vollständig.

approved_phones
string[]

Verifizierte Telefonnummern für diesen Benutzer. Ersetzt die gespeicherte Liste vollständig.

issuing_states
string[]

Ausstellungsländer (ISO 3166-1 Alpha-3), z. B. ["USA"]. Ersetzt die gespeicherte Liste vollständig.

reason
string | null

Warum sich der Status geändert hat. Wird im Statusänderungseintrag der Benutzeraktivität (comments[].comment und Activity in der Business Console) erfasst, nur wenn sich der Status tatsächlich ändert. Webhooks übertragen dies nicht.

Maximum string length: 1000

Antwort

Benutzer aktualisiert. Der vollständige aktualisierte Benutzerdatensatz (gleiches Format wie bei Get User) wird zurückgegeben.

Vollständige Benutzerdetails. Erweitert UserListItem um Metadaten, Kommentare und updated_at.

didit_internal_id
string<uuid>

Didits stabile interne UUID für diesen Benutzer.

vendor_data
string | null

Ihre eindeutige Kennung für diesen Benutzer (beim Erstellen von Sitzungen übergeben). Dies kann null sein, wenn keine Vendor-Kennung angegeben wurde.

display_name
string | null

Von Ihnen festgelegter benutzerdefinierter Anzeigename

full_name
string | null

Aus verifizierten Dokumenten extrahierter vollständiger Name

date_of_birth
string<date> | null
effective_name
string | null

Bester verfügbarer Name: display_name, falls gesetzt, andernfalls full_name

status
enum<string>

Lebenszyklusstatus des Benutzerdatensatzes (KEIN Sitzungsstatus). ACTIVE ist der Standard, FLAGGED markiert den Benutzer für manuelle Prüfung, BLOCKED verhindert neue Sitzungen für dieses vendor_data.

Verfügbare Optionen:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

Vorsignierte URL des Porträtfotos des Benutzers (läuft nach wenigen Stunden ab)

session_count
integer

Gesamtzahl der Verifizierungssitzungen für diesen Benutzer

approved_count
integer

Anzahl der genehmigten Sitzungen

declined_count
integer

Anzahl der abgelehnten Sitzungen

in_review_count
integer

Anzahl der Sitzungen in Prüfung

issuing_states
string[]

ISO 3166-1-Alpha-3-Codes der Ausstellungsländer, die auf den genehmigten Ausweisdokumenten dieses Benutzers gefunden wurden, z. B. ["USA", "ESP"]. Leeres Array, wenn keine vorhanden sind.

approved_emails
string[]

Verifizierte E-Mail-Adressen, die aus den genehmigten Sitzungen dieses Benutzers erfasst wurden, z. B. ["john@example.com"].

approved_phones
string[]

Verifizierte Telefonnummern, die aus den genehmigten Sitzungen dieses Benutzers erfasst wurden, z. B. ["+14155551234"].

features
object

Aggregierter Status pro Funktion über alle Sitzungen dieses Benutzers hinweg. Mögliche Schlüssel: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Mögliche Werte: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Dieselben Daten wie features, als geordnetes Array von {feature, status}-Objekten.

last_session_at
string<date-time> | null

Zeitstempel der letzten Sitzung

first_session_at
string<date-time> | null

Zeitstempel der ersten Sitzung

last_activity_at
string<date-time> | null

Zeitstempel der letzten Aktivität bei diesem Benutzer (Sitzung, Transaktion, Statusänderung, Datenbearbeitung usw.).

tags
object[]

Tag-Zuweisungen. HINWEIS: Bei Detailantworten ist jeder Eintrag ein Tag-Link-Objekt ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), anders als die flache Struktur {uuid, name, color}, die bei Listenantworten verwendet wird.

created_at
string<date-time>
metadata
object

Benutzerdefiniertes Metadaten-JSON, das Sie diesem Benutzer angehängt haben. Standardmäßig {}.

comments
object[]

Aktivitätsprotokoll und Kommentare für diesen Benutzer (Statusänderungen, Profilbearbeitungen, manuelle Notizen).

updated_at
string<date-time>
Zuletzt geändert am 7. November 2026