Zum Hauptinhalt springen
GET
curl
Ruft die Einträge einer Liste ab, neueste zuerst, optional mit Suche. search findet Teilübereinstimmungen im Wert oder Label eines Eintrags, unabhängig von Groß- und Kleinschreibung. reference_session_id schränkt die Ergebnisse auf die Einträge ein, die aus einer bestimmten Verifizierungssitzung stammen. Bei einer Gesichtsliste gibt metadata.face_image_source an, welches Gesicht der Sitzung der jeweilige Eintrag ist (liveness, wenn der Wert fehlt). Gesichts- und Dokumenteinträge enthalten Bild-URLs in metadata, die kurz nach dem Aufruf ablaufen. Rufen Sie die Einträge erneut ab, um frische URLs zu erhalten, statt sie zu speichern. Ein API-Schlüssel ohne media: read erhält für diese URLs null.

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

list_uuid
string<uuid>
erforderlich

UUID der Liste, wie sie von „Listen auflisten“ oder „Liste erstellen“ zurückgegeben wird.

Abfrageparameter

Text (ohne Berücksichtigung von Groß-/Kleinschreibung), den value oder display_label des Eintrags enthalten muss.

reference_session_id
string<uuid>

Nur die Einträge aus dieser Personen-Verifizierungssitzung, um beispielsweise zu sehen, welche ihrer Gesichter bereits aufgeführt sind.

limit
integer
Standard:50

Seitengröße. Standardmäßig 50. Ein Wert über 1000000 gibt 400 zurück; 0, ein negativer oder ein nicht-numerischer Wert fällt auf 50 zurück.

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

Nullbasierter Index des ersten zurückzugebenden Elements. Folgen Sie vorzugsweise next. Ein Wert über 1000000 gibt 400 zurück; ein negativer oder nicht-numerischer Wert fällt auf 0 zurück.

Erforderlicher Bereich: 0 <= x <= 1000000

Antwort

Eine Seite mit Einträgen, neueste zuerst.

count
integer
erforderlich

Gesamtzahl der Einträge, die den Filtern entsprechen.

Erforderlicher Bereich: x >= 0
next
string<uri> | null
erforderlich

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

previous
string<uri> | null
erforderlich

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

results
object[]
erforderlich
Zuletzt geändert am 7. November 2026