Zum Hauptinhalt springen
POST
Python
Die Look-Up-Users-API von Didit ordnet eine Liste mit bis zu 20.000 Kennungen in einem einzigen Aufruf den Benutzern Ihrer Anwendung zu und zeigt Ihnen an, welche Kennungen keinem Benutzer entsprechen. Verwenden Sie sie, wenn Sie eine Liste von Konten haben, etwa die Empfänger eines Auszahlungsstapels, die Konten eines Partners oder das Ergebnis einer Betrugsabfrage, und den Verifizierungsstatus jedes einzelnen Kontos benötigen.

So funktioniert es

  1. Liste abfragen. POST /v3/users/lookup/ mit Ihren Kennungen. Der Aufruf liest nur und liefert eine lookup_id, die Anzahlen sowie die Kennungen, denen kein Benutzer zugeordnet wurde.
  2. Benutzer abrufen. Übergeben Sie die lookup_id als lookup an Benutzer auflisten. Es werden nur die übereinstimmenden Benutzer zurückgegeben, und zwar in der Reihenfolge, in der Sie die Kennungen übermittelt haben.

Abgleichsregeln

Jede Kennung wird innerhalb Ihrer Anwendung in dieser Reihenfolge abgeglichen:
  • Leere Einträge werden verworfen. Doppelte Einträge werden entfernt, wobei das erste Vorkommen erhalten bleibt.
  • Eine Anfrage darf höchstens 100.000 Einträge enthalten. Nachdem leere Einträge und Duplikate entfernt wurden, müssen zwischen 1 und 20.000 Kennungen übrig bleiben. Wird eines der beiden Limits überschritten, gibt die Anfrage 400 mit code: too_many_identifiers zurück.
  • Die Suche erfolgt ausschließlich in Ihrer Anwendung.

Anfrage

Antwort

Die gefundenen Benutzer abrufen

  • Benutzer werden in der Reihenfolge ihrer Kennung in Ihrer Liste zurückgegeben und mit limit und offset paginiert. Wenn eine E-Mail-Adresse mehreren Benutzern zugeordnet ist, werden diese nach Kontoalter aufsteigend aufgelistet, das älteste Konto zuerst.
  • Das Ergebnis wird 24 Stunden lang nur für Ihre Anwendung aufbewahrt. Danach gibt lookup 404 mit code: lookup_not_found zurück: Senden Sie die Liste erneut.

Einen Lookup abrufen

GET /v3/users/lookup/{lookup_id}/ gibt denselben Antworttext zurück wie der Lookup, zusätzlich identifiers: die Liste, die Sie übermittelt haben, nachdem leere Einträge und Duplikate entfernt wurden, in der übermittelten Reihenfolge. Der Endpoint antwortet mit 404 und code: lookup_not_found, wenn der Lookup abgelaufen ist, nicht existiert oder zu einer anderen Anwendung gehört.

Errors

Berechtigungen

Der API-Schlüssel benötigt Lesezugriff auf Benutzer, und der Endpoint ändert niemals Daten. Ein Schlüssel ohne diese Berechtigung oder ein widerrufener Schlüssel erhält 403. Die Scopes eines Schlüssels werden pro Schlüssel in den API-Schlüsseln festgelegt. Die Rollen und Berechtigungen der Console bestimmen, was eine Person in der Console tun darf, und werden für API-Anfragen nicht geprüft. In der Console benötigt Liste abfragen nur die Berechtigung, Benutzer zu lesen.

Verwandte Themen

Autorisierungen

x-api-key
string
header
erforderlich

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Body

application/json
identifiers
string[]
erforderlich

Each entry is a vendor_data value, a Didit user ID or a verified email. Send at most 100,000 entries. Blank entries are dropped and duplicates removed, keeping the first, and at most 20,000 identifiers must remain. Either limit exceeded is a 400 with code: too_many_identifiers, and an empty list is a 400 too.

Maximum array length: 100000
Beispiel:

Antwort

The lookup was read. Use lookup_id with List users.

lookup_id
string<uuid>
erforderlich

Pass it as lookup to List users.

requested
integer
erforderlich

Identifiers read, after blanks and duplicates were removed.

found
integer
erforderlich

Identifiers that matched at least one user.

not_found
object[]
erforderlich
expires_at
string<date-time>
erforderlich

When the result expires (24 hours after the lookup).

Zuletzt geändert am 20. November 2026