Zum Hauptinhalt springen
GET
curl

Überblick

Gibt eine einzelne User-Entität zurück, die über vendor_data identifiziert wird. Antworten enthalten didit_internal_id, die stabile interne Kennung von Didit.

Wann verwenden

  • Abfrage des aktuellen Verifizierungsstatus eines Benutzers: Die features-Zuordnung liefert den neuesten Status jeder Funktion in einem einzigen Objekt.
  • Detailansichten in Ihrer eigenen Benutzeroberfläche: Rufen Sie das Profil bei Bedarf ab, bevor Sie es anzeigen.
  • Risiko-Scoring: Kombinieren Sie Sitzungszähler und features, um jeden Benutzer auf Ihrer Seite zu bewerten.

Hinweise

  • vendor_data in der URL unterscheidet zwischen Groß- und Kleinschreibung.
  • Gibt 404 zurück, wenn in der Anwendung kein Benutzer mit diesem vendor_data existiert.
  • Aggregierte Zähler (session_count, approved_count, declined_count, in_review_count) werden in Echtzeit aktualisiert, sobald Sitzungen abgeschlossen sind.
  • Alle Felder finden Sie im Datenmodell für Benutzer.

Berechtigungen

Jeder aktive API-Schlüssel der Anwendung kann diesen Endpoint aufrufen. API-Schlüssel von Didit sind anwendungsbezogen, nicht rollenbezogen: Die Rollen und Berechtigungen der Console (read:users und die übrigen) bestimmen, was eine Person in der Console tun darf, und werden für Datenverkehr der Management API nicht ausgewertet. Steuern Sie, wer diesen Endpoint aufrufen kann, indem Sie steuern, wer den API-Schlüssel der Anwendung lesen kann.

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

vendor_data
string
erforderlich

Ihre eindeutige Kennung für den Benutzer — ein Freitext-String (KEINE UUID). Dies ist derselbe Wert, den Sie beim Erstellen der Sitzung, in der dieser Benutzer erstmals eingeführt wurde, als vendor_data übergeben haben, exakt wie übermittelt abgeglichen.

Antwort

Vollständige Benutzerdetails einschließlich Metadaten, Kommentaren/Aktivitätsprotokoll und aggregierten Sitzungsdaten.

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