Zum Hauptinhalt springen
GET
curl

Filter nach Sitzungsart

Verwenden Sie den Query-Parameter session_kind, um festzulegen, welche Art von Sitzungen zurückgegeben wird: Jede Zeile der Antwort enthält session_kind: "user" | "business", damit Ihr Client die Struktur pro Zeile unterscheiden kann.

Gemeinsame Filter

Diese Filter gelten für beide Arten. Die nur für Benutzer vorgesehenen Filter werden ignoriert, wenn session_kind=business gesetzt ist, und umgekehrt:

Beispiele

Antwort (gekürzt):

Zeilenstrukturen unterscheiden sich nach Art

Zeilen der Benutzerverifizierung (KYC) enthalten portrait_image, document_type, full_name, country (Ausstellungsstaat), phone_number, email_address sowie einige Prüffelder: assignee (der Prüfer in der Console, dem die Sitzung zugewiesen ist, oder null), waiting_since und sla_due_at (nur gesetzt, solange die Sitzung In Review ist), top_warnings (die wichtigsten Warnungen, jeweils mit risk, feature, log_type und short_description) und warnings_count. Zeilen der Unternehmensverifizierung (KYB) enthalten workflow_type, workflow_label, company_name, registration_number und country (Gründungsland). Beide enthalten session_id, session_kind, session_number, status, vendor_data und created_at. Die vollständige Funktionsmatrix finden Sie unter Sitzungsübersicht.

Paginierung

Die Paginierung verwendet limit (Standard 50) und offset (Standard 0). Die Antwort enthält absolute URLs für next und previous. Beide Parameter akzeptieren Werte bis 1000000; ein größerer Wert liefert 400. count ist bis 100 exakt und bleibt darüber bei 100. Verwenden Sie den Wert daher nicht als Gesamtzahl. Rufen Sie die URL in next so lange ab, bis sie null ist. Bei session_kind=all ist count die Summe beider Arten, wobei jede Art auf 100 begrenzt ist.

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.

Abfrageparameter

session_kind
enum<string>
Standard:user

Welche Art von Sitzungen aufgelistet werden soll: user (nur KYC, Standard), business (nur KYB) oder all (beide verkettet - siehe Beschreibung für die Semantik der zusammengeführten Paginierung). Beim Abgleich wird die Groß-/Kleinschreibung nicht berücksichtigt (BUSINESS funktioniert); jeder andere Wert als eine Schreibweisenvariante von user/business/all gibt 400 zurück.

Verfügbare Optionen:
user,
business,
all
limit
integer
Standard:50

Maximale Anzahl an Zeilen pro Seite (pro Art, wenn session_kind=all). Standardmäßig 50.

Erforderlicher Bereich: 1 <= x <= 1000000
offset
integer
Standard:0

Anzahl der vor der ersten zurückgegebenen Zeile zu überspringenden Zeilen. Standardmäßig 0. Folgen Sie vorzugsweise den next/previous-URLs aus der Antwort.

Erforderlicher Bereich: 0 <= x <= 1000000
status
string

Kommagetrennte Liste der einzuschließenden Sitzungsstatus, z. B. Approved,In Review. Bei den Werten wird zwischen Groß- und Kleinschreibung unterschieden; siehe Verifizierungsstatus. Unbekannte Werte stimmen mit nichts überein.

vendor_data
string

Exakter Übereinstimmungsfilter für die vendor_data, die Sie bei der Sitzungserstellung übermittelt haben (Ihre eigene Benutzer-/Unternehmenskennung). Für Teilübereinstimmungen verwenden Sie stattdessen search.

Eine vollständige angezeigte Referenz wie S-0001 (Benutzer) oder B-0001 (Unternehmen) stimmt nur mit dieser Sitzungsnummer und Art überein; führende Nullen und Groß-/Kleinschreibung haben keinen Einfluss auf die Übereinstimmung. Intelligente Freitextsuche. Eine vollständige UUID stimmt mit session_id überein; numerische Eingaben stimmen mit Sitzungsnummern-Präfixen, Dokumenten-/persönlichen Nummern, Telefonvorwahlen oder vendor_data überein; Eingaben mit @ stimmen mit E-Mail-Präfixen überein; anderer Text stimmt mit Namen (ohne Berücksichtigung von Akzenten) und vendor_data überein. Freitext mit Ziffern stimmt zusätzlich mit Suchfeldern für Dokumenten-/persönliche Nummern und Sitzungsnummern-Präfixen überein.

workflow_id
string

Kommagetrennte Workflow-UUIDs (Sie finden sie auf der Seite „Workflows“ in der Console). Ungültig formatierte UUIDs in der Liste werden ignoriert; wenn keine gültig ist, ist das Ergebnis leer.

date_from
string<date>

Nur Sitzungen, die an oder nach diesem Datum (UTC) erstellt wurden, Format YYYY-MM-DD. Fehlerhafte Datumsangaben geben 400 zurück.

date_to
string<date>

Nur Sitzungen, die bis zu diesem Datum (UTC) erstellt wurden, Format YYYY-MM-DD. Für KYC-Zeilen wird der gesamte Tag einbezogen; für KYB-Zeilen lautet der Vergleich created_at <= date_to (Mitternacht), verwenden Sie daher das Datum des nächsten Tages, um einen vollständigen Tag mit KYB-Sitzungen einzuschließen.

tags
string

Kommagetrennte Tag-IDs (tags Ihrer Anwendung). Gibt die Sitzungen zurück, die eines davon enthalten. IDs, die keine gültigen UUIDs sind, werden ignoriert, und wenn keine gültig ist, ist die Liste leer.

decided_from
string<date-time>

ISO 8601-Datum/Uhrzeit. Gibt die Sitzungen zurück, deren Status sich zuletzt zu diesem Zeitpunkt oder danach geändert hat. Filtert nach dem Zeitpunkt der letzten Statusänderung, nicht nach dem Erstellungszeitpunkt.

decided_to
string<date-time>

ISO 8601-Datum/Uhrzeit. Gibt die Sitzungen zurück, deren Status sich zuletzt davor geändert hat. Kombinieren Sie dies mit decided_from für ein halboffenes Intervall.

country
string

Kommagetrennter Länderfilter. Für KYC-Zeilen: ISO 3166-1-Alpha-3-Codes des Ausstellungsstaates des Ausweisdokuments (z. B. ESP,USA), der von der Staatsangehörigkeit abweichen kann. Für KYB-Zeilen: der Ländercode des im Unternehmensregister eingetragenen Unternehmens.

document_type
string

Kommagetrennte Codes der in der Sitzung verifizierten Ausweisdokumenttypen (nur KYC-Zeilen): P (Reisepass), ID (Personalausweis), DL (Führerschein), RP (Aufenthaltstitel), SSC (Sozialversicherungsausweis), HIC (Krankenversicherungskarte), WP (Arbeitserlaubnis), TC (Steuerkarte), VISA, PSC (Public Service Card), BC (Geburtsurkunde), OTHER. Beachten Sie, dass das Antwortfeld document_type den Anzeigenamen enthält, nicht den Code.

document_name
string

Exakte Dokumentnamen; mehrere Namen können kommagetrennt übergeben werden, der Wert wird jedoch nur an Kommas aufgeteilt, wenn er mehr als ein Trennzeichen - enthält (ein einzelner Name mit einem eingebetteten Komma wird als Ganzes abgeglichen). Namen, wie sie von der Dokumentenprüfung erkannt werden (Vorder- oder Rückseite), z. B. Spain - Id Card (2021). Nur KYC-Zeilen.

region
string

Kommagetrennte Werte für Dokumentregion/-bundesstaat (für Dokumente, die pro Region ausgestellt werden, wie etwa US-Führerscheine). Nur KYC-Zeilen.

didit_internal_id
string<uuid>

Filtern Sie nach Didits internem Benutzerbezeichner (dem Antwortfeld didit_internal_id), um alle Sitzungen eines verifizierten Benutzers aufzulisten. Muss eine gültige UUID sein; fehlerhafte Werte geben 400 zurück. Nur KYC-Zeilen.

session_type
string

Kommagetrennte Kanäle zur Sitzungserstellung: API, HOSTED, MIGRATED. Der spezielle Wert ALL (oder das Weglassen des Parameters) deaktiviert den Filter. Nur für KYC-Zeilen.

api_service
enum<string>

Eigenständige API-Sitzungen nach Dienst filtern. Ungültige Werte geben 400 zurück. Nur KYC-Zeilen.

Verfügbare Optionen:
ID_VERIFICATION,
FACE_MATCH,
AGE_ESTIMATION,
FACE_SEARCH,
POA,
AML,
KYB_REGISTRY,
PASSIVE_LIVENESS,
DATABASE_VALIDATION,
PHONE_VERIFICATION,
EMAIL_VERIFICATION
screened_full_name
string

Namenssuche ohne Berücksichtigung von Akzenten innerhalb der durch AML und Datenbankvalidierung geprüften Daten. In Kombination mit api_service=AML oder api_service=DATABASE_VALIDATION wird die Suche auf die geprüften Daten dieser Funktion beschränkt. Nur KYC-Zeilen.

warning
string

Kommagetrennte Risiko-Codes für Warnungen; gibt Sitzungen zurück, die einen davon ausgelöst haben (z. B. POSSIBLE_FRAUD). Risiko-Codes sind pro Funktion in der Warnungsdokumentation aufgeführt. Gilt für KYC-Zeilen und, mit Warnungs-Codes für Unternehmen, für KYB-Zeilen.

status_initialized_as_in_review
boolean

Wenn true, nur Sitzungen, deren Entscheidung anfänglich auf In Review fiel (nützlich zur Überprüfung des Volumens manueller Prüfungen). Nur KYC-Zeilen.

is_kyc_to_be_reviewed
boolean

true gibt Sitzungen zurück, deren Dokumentenprüfung für eine manuelle Prüfung markiert ist; false gibt Sitzungen zurück, bei denen die Dokumentenprüfung ausdrücklich nicht markiert ist. Weglassen zum Deaktivieren. Nur KYC-Zeilen.

euuid
string<uuid>

Nach der euuid des Endbenutzers filtern (dem zu verifizierenden Benutzer zugewiesene UUID, die von Console-Deeplinks verwendet wird). Muss eine gültige UUID sein; fehlerhafte Werte geben einen 400-Feldfehler zurück. Nur KYC-Zeilen.

organization_name
string

Kommagetrennte Organisationsnamen. Für die Console vorgesehen; mit einem API-Schlüssel (der bereits auf eine Anwendung beschränkt ist) stimmt dies nur mit dem Namen Ihrer eigenen Organisation überein.

Antwort

Paginierte Sitzungsliste. results-Einträge sind je nach session_kind KYC-Zeilen, KYB-Zeilen oder beides; unterscheiden Sie anhand des Felds session_kind jeder Zeile.

count
integer
erforderlich

Anzahl der den Filtern entsprechenden Sitzungen: exakt bis 100 und darüber auf 100 begrenzt, verwenden Sie sie daher nicht als Gesamtsumme. Nutzen Sie next, um zu erfahren, ob weitere Seiten vorhanden sind. Bei session_kind=all ist es die Summe beider Arten, jeweils auf 100 begrenzt.

Beispiel:

2

next
string<uri> | null
erforderlich

Absolute URL der nächsten Seite oder null auf der letzten Seite.

Beispiel:

"https://verification.didit.me/v3/sessions/?limit=20&offset=20"

previous
string<uri> | null
erforderlich

Absolute URL der vorherigen Seite oder null auf der ersten Seite.

Beispiel:

null

results
(KYC session row (session_kind: user) · object | KYB session row (session_kind: business) · object)[]
erforderlich

Sitzungszeilen, neueste zuerst. Bei session_kind=all stehen KYC-Zeilen an erster Stelle, gefolgt von KYB-Zeilen.

Zusammenfassungszeile für eine Benutzerverifizierungs-Sitzung (KYC). Identitätsfelder (full_name, country, document_type, portrait_image, Kontaktfelder) werden schrittweise ausgefüllt, während der Benutzer die Verifizierungsschritte abschließt, und sind null, bis der entsprechende Schritt abgeschlossen ist. Felder, die durch die Konfiguration der Antwortattribute des Workflows eingeschränkt sind, werden ebenfalls als null zurückgegeben.

Zuletzt geändert am 7. November 2026