Saltar al contingut principal
POST
Python
L’API Look Up Users de Didit associa en una sola crida una llista de fins a 20.000 identificadors amb els usuaris de la teva aplicació, i t’indica quins identificadors no han coincidit amb cap usuari. Utilitza-la quan tinguis una llista de comptes, com ara els beneficiaris d’un lot de pagaments, els comptes d’un soci o el resultat d’una consulta de frau, i necessitis l’estat de verificació de cadascun.

Com funciona

  1. Consulta la llista. POST /v3/users/lookup/ amb els teus identificadors. La crida només llegeix i respon amb un lookup_id, els recomptes i els identificadors que no han coincidit amb cap usuari.
  2. Llegeix els usuaris. Passa el lookup_id com a lookup a Llista d’usuaris. Retorna només els usuaris coincidents, en l’ordre en què has enviat els identificadors.

Regles de coincidència

Cada identificador es fa coincidir dins de la teva aplicació, en aquest ordre:
  • Les entrades en blanc s’eliminen, i els duplicats també s’eliminen i es manté el primer.
  • Una sol·licitud envia com a màxim 100.000 entrades. Després d’eliminar les entrades en blanc i els duplicats, han de quedar entre 1 i 20.000 identificadors. Si se supera qualsevol dels dos límits, es retorna 400 amb code: too_many_identifiers.
  • La cerca només busca a la teva aplicació.

Sol·licitud

Resposta

Llegeix els usuaris coincidents

  • Els usuaris es retornen en l’ordre del seu identificador a la teva llista, paginats amb limit i offset. Quan un correu electrònic coincideix amb diversos usuaris, es mostren primer els comptes més antics.
  • El resultat es conserva durant 24 hores, només per a la teva aplicació. Després, lookup retorna 404 amb code: lookup_not_found: envia de nou la llista.

Recuperar una consulta

GET /v3/users/lookup/{lookup_id}/ retorna el mateix cos que la consulta, més identifiers: la llista que has enviat després d’eliminar els espais en blanc i els duplicats, en el mateix ordre. Respon amb 404 i code: lookup_not_found quan la consulta ha caducat, no existeix o pertany a una altra aplicació.

Errors

Permisos

La clau d’API necessita accés de lectura als usuaris, i l’endpoint no modifica mai les dades. Una clau sense aquest accés, o una clau revocada, rep 403. Els àmbits de la clau s’estableixen per clau a Claus d’API; els rols i permisos de la Console decideixen què pot fer una persona a la Console i no s’avaluen per al trànsit de l’API. A la Console, Consulta una llista només necessita el permís per llegir usuaris.

Relacionats

Autoritzacions

x-api-key
string
header
requerit

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.

Cos

application/json
identifiers
string[]
requerit

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
Exemple:

Resposta

The lookup was read. Use lookup_id with List users.

lookup_id
string<uuid>
requerit

Pass it as lookup to List users.

requested
integer
requerit

Identifiers read, after blanks and duplicates were removed.

found
integer
requerit

Identifiers that matched at least one user.

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

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

Darrera modificació el 20 de novembre del 2026