Saltar al contingut principal
GET
curl

Descripció general

Retorna una única entitat d’usuari identificada per vendor_data. Les respostes inclouen didit_internal_id, l’identificador intern estable de Didit.

Quan utilitzar-lo

  • Consulta de l’estat de verificació actual d’un usuari: el mapa features et dona l’estat més recent de cada funcionalitat en un sol objecte.
  • Vistes de detall a la teva pròpia interfície: obtén el perfil sota demanda abans de renderitzar-lo.
  • Puntuació de risc: combina els comptadors de sessions i features per puntuar cada usuari pel teu compte.

Notes

  • vendor_data a la URL distingeix entre majúscules i minúscules.
  • Retorna 404 si no existeix cap usuari amb aquest vendor_data a l’aplicació.
  • Els comptadors agregats (session_count, approved_count, declined_count, in_review_count) s’actualitzen en temps real a mesura que es completen les sessions.
  • Consulta el model de dades d’usuari per veure tots els camps.

Permisos

Qualsevol clau d’API activa de l’aplicació pot cridar aquest endpoint. Les claus d’API de Didit tenen un àmbit d’aplicació, no de rol: els rols i permisos de la Consola (read:users i la resta) decideixen què pot fer una persona a la Consola, i no s’avaluen per al trànsit de la Management API. Controla qui pot cridar aquest endpoint controlant qui pot llegir la clau d’API de l’aplicació.

Relacionat

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

vendor_data
string
requerit

El teu identificador únic per a l'usuari — una cadena de text lliure (NO un UUID). És el mateix valor que vas passar com a vendor_data quan vas crear la sessió que va introduir aquest usuari per primera vegada, que coincideix exactament amb el valor enviat.

Resposta

Detall complet de l'usuari, incloent-hi metadades, registre de comentaris/activitat i dades agregades de la sessió.

Detall complet de l'usuari. Amplia UserListItem amb metadades, comentaris i updated_at.

didit_internal_id
string<uuid>

UUID intern estable de Didit per a aquest usuari.

vendor_data
string | null

El teu identificador únic per a aquest usuari (passat en crear sessions). Pot ser nul quan no s'ha proporcionat cap identificador de proveïdor.

display_name
string | null

Nom visible personalitzat definit per tu

full_name
string | null

Nom complet extret dels documents verificats

date_of_birth
string<date> | null
effective_name
string | null

Millor nom disponible: display_name si està definit, en cas contrari full_name

status
enum<string>

Estat del cicle de vida del registre d'usuari (NO és un estat de la sessió). ACTIVE és el valor per defecte, FLAGGED marca l'usuari per a atenció manual, BLOCKED impedeix noves sessions per a aquest vendor_data.

Opcions disponibles:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

URL presignada de la foto de retrat de l'usuari (caduca al cap d'unes hores)

session_count
integer

Nombre total de sessions de verificació per a aquest usuari

approved_count
integer

Nombre de sessions aprovades

declined_count
integer

Nombre de sessions rebutjades

in_review_count
integer

Nombre de sessions en revisió

issuing_states
string[]

Codis ISO 3166-1 alpha-3 dels països emissors que consten als documents d'identitat aprovats d'aquest usuari, p. ex. ["USA", "ESP"]. Matriu buida si no n'hi ha cap.

approved_emails
string[]

Adreces de correu electrònic verificades recollides de les sessions aprovades d'aquest usuari, p. ex. ["john@example.com"].

approved_phones
string[]

Números de telèfon verificats recollits de les sessions aprovades d'aquest usuari, p. ex. ["+14155551234"].

features
object

Estat agregat per funcionalitat a totes les sessions d'aquest usuari. Claus possibles: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valors possibles: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Les mateixes dades que features, com una llista ordenada d'objectes {feature, status}.

last_session_at
string<date-time> | null

Marca de temps de la sessió més recent

first_session_at
string<date-time> | null

Marca de temps de la primera sessió

last_activity_at
string<date-time> | null

Marca de temps de l'activitat més recent d'aquest usuari (sessió, transacció, canvi d'estat, edició de dades, etc.).

tags
object[]

Assignacions d'etiquetes. NOTA: a les respostes de detall cada entrada és un objecte d'enllaç d'etiqueta ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), a diferència de l'estructura plana {uuid, name, color} utilitzada a les respostes de llista.

created_at
string<date-time>
metadata
object

JSON de metadades personalitzades que has adjuntat a aquest usuari. Per defecte és {}.

comments
object[]

Registre d'activitat i comentaris per a aquest usuari (canvis d'estat, edicions de perfil, notes manuals).

updated_at
string<date-time>
Darrera modificació el 7 de novembre del 2026