> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Obtenir usuari API: entitat d'usuari del proveïdor > Obté un usuari de Didit per vendor_data: identitat, estat, comptadors KYC i funcionalitats. KYC persistent, de pagament per crida. Prompt per obtenir un usuari Copia el prompt al porta-retalls \

\`Goal: Fetch a single Didit User entity by your own vendor_data.

Endpoint: GET https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key: 

Path param:
\- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after Didit normalisation. URL-encode it.

curl:
curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (UserDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
\- didit_internal_id (UUID — Didit's stable internal identifier)
\- vendor_data (string)
\- display_name, full_name, date_of_birth, effective_name, portrait_image_url
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices)
\- session_count, approved_count, declined_count, in_review_count (aggregate counters)
\- features (map of feature -> latest status)
\- approved_emails, approved_phones, issuing_states
\- metadata (arbitrary JSON you attached)
\- comments (chronological activity log: status changes, manual notes, system events)
\- created_at, updated_at
See /reference/data-models for the full schema.

Notes:
\- Aggregate counters update in real time as sessions reach terminal status.
\- For bulk lookups, prefer paging GET /v3/users/ and indexing locally on vendor_data instead of fanning out one call per identifier.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing or invalid x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 404 — no user with that vendor_data in this application.
\- 429 — rate-limited.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Enganxa a ## Descripció generalRetorna una única [entitat d'usuari](https://docs.didit.me/ca/entities/users/overview.md) 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](https://docs.didit.me/ca/entities/users/data-model.md) per veure tots els camps.## PermisosQualsevol 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](https://docs.didit.me/ca/console/roles-permissions.md) 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- [Descripció general dels usuaris](https://docs.didit.me/ca/entities/users/overview.md) - [Model de dades](https://docs.didit.me/ca/entities/users/data-model.md) - [Llistar usuaris](https://docs.didit.me/ca/management-api/users/list.md) ## OpenAPI ````yaml ca/openapi-25.json GET /v3/users/{vendor_data}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/users/{vendor_data}/: get: tags: - Users summary: Obtenir l'usuari description: >- Obté un [usuari](/entities/users) per `vendor_data` (coincidència exacta). Afegeix `metadata`, `comments` i `updated_at` a la visualització de llista, i canvia `tags` al format detallat d'enllaç d'etiquetes. operationId: get_user parameters: - name: vendor_data in: path required: true schema: type: string description: >- 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. example: user-abc-123 responses: '200': description: >- Detall complet de l'usuari, incloent-hi metadades, registre de comentaris/activitat i dades agregades de la sessió. content: application/json: schema: $ref: '#/components/schemas/UserDetailItem' examples: Active user: value: didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418 vendor_data: user-abc-123 display_name: null full_name: John Michael Doe date_of_birth: '1990-05-15' effective_name: John Michael Doe status: ACTIVE metadata: tier: premium source: website portrait_image_url: https:///... session_count: 3 approved_count: 2 declined_count: 0 in_review_count: 1 issuing_states: - USA approved_emails: - john@example.com approved_phones: - '+14155551234' features: ID_VERIFICATION: Approved LIVENESS: Approved FACE_MATCH: Approved AML: Approved features_list: - feature: ID_VERIFICATION status: Approved - feature: LIVENESS status: Approved - feature: FACE_MATCH status: Approved - feature: AML status: Approved last_session_at: '2025-06-15T10:30:00Z' last_activity_at: '2025-06-15T10:30:00Z' first_session_at: '2025-06-01T08:00:00Z' tags: - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d tag: uuid: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b name: VIP color: '#2567FF' description: null source: custom created_at: '2025-05-01T09:00:00Z' updated_at: '2025-05-01T09:00:00Z' added_by_email: analyst@acme.com added_by_name: Jane Analyst created_at: '2025-06-02T11:00:00Z' comments: - uuid: c1111111-2222-4333-8444-555555555555 comment_type: STATUS_CHANGED comment: null actor_email: analyst@acme.com actor_name: Jane Analyst previous_status: FLAGGED new_status: ACTIVE previous_value: null new_value: null changed_fields: [] metadata: null mentioned_emails: [] created_at: '2025-06-01T10:30:00Z' created_at: '2025-06-01T08:00:00Z' updated_at: '2025-06-15T10:30:00Z' '401': description: >- No s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'API. content: application/json: examples: Missing credentials: value: detail: >- You must be authenticated with a valid access token to access this endpoint. '403': description: >- Clau d'API no vàlida o revocada, o la clau no pot llegir els usuaris d'aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: >- No existeix cap usuari amb el `vendor_data` proporcionat per a aquesta aplicació. content: application/json: examples: Not found: value: detail: Not found. '429': description: >- S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`. content: application/json: examples: Rate limited: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.retrieve( "user-abc-123", ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.users.retrieve("user-abc-123"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Retrieve(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.users().retrieve("user-abc-123"); System.out.println(result); - lang: php label: PHP source: |- users->retrieve('user-abc-123'); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.retrieve("user-abc-123") puts result.to_h - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Users.RetrieveAsync("user-abc-123"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: UserDetailItem: type: object description: >- Detall complet de l'usuari. Amplia UserListItem amb metadades, comentaris i updated_at. allOf: - $ref: '#/components/schemas/UserListItem' - type: object properties: metadata: type: object description: >- JSON de metadades personalitzades que has adjuntat a aquest usuari. Per defecte és `{}`. tags: type: array description: >- 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. items: type: object properties: uuid: type: string format: uuid description: UUID de l'assignació de l'etiqueta (no l'etiqueta en si). tag: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: type: string nullable: true source: type: string enum: - didit - custom created_at: type: string format: date-time updated_at: type: string format: date-time added_by_email: type: string nullable: true added_by_name: type: string nullable: true created_at: type: string format: date-time comments: type: array items: type: object properties: uuid: type: string format: uuid comment_type: type: string enum: - COMMENT - STATUS_CHANGED - METADATA_UPDATED - TAG_ADDED - TAG_REMOVED - PROFILE_UPDATED comment: type: string nullable: true actor_email: type: string nullable: true actor_name: type: string nullable: true previous_status: type: string nullable: true enum: - ACTIVE - FLAGGED - BLOCKED - null new_status: type: string nullable: true enum: - ACTIVE - FLAGGED - BLOCKED - null previous_value: type: object nullable: true description: Valors de camp anteriors per a entrades PROFILE_UPDATED. new_value: type: object nullable: true description: Nous valors de camp per a les entrades PROFILE_UPDATED. changed_fields: type: array items: type: string description: >- Noms dels camps modificats per una entrada PROFILE_UPDATED. metadata: type: object nullable: true mentioned_emails: type: array items: type: string created_at: type: string format: date-time description: >- Registre d'activitat i comentaris per a aquest usuari (canvis d'estat, edicions de perfil, notes manuals). updated_at: type: string format: date-time UserListItem: type: object description: Un usuari verificat. properties: didit_internal_id: type: string format: uuid description: UUID intern estable de Didit per a aquest usuari. vendor_data: type: string nullable: true description: >- 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: type: string nullable: true description: Nom visible personalitzat definit per tu full_name: type: string nullable: true description: Nom complet extret dels documents verificats date_of_birth: type: string format: date nullable: true effective_name: type: string nullable: true description: >- Millor nom disponible: display_name si està definit, en cas contrari full_name status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- 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`. portrait_image_url: type: string nullable: true description: >- URL presignada de la foto de retrat de l'usuari (caduca al cap d'unes hores) session_count: type: integer description: Nombre total de sessions de verificació per a aquest usuari approved_count: type: integer description: Nombre de sessions aprovades declined_count: type: integer description: Nombre de sessions rebutjades in_review_count: type: integer description: Nombre de sessions en revisió issuing_states: type: array items: type: string description: >- 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: type: array items: type: string description: >- Adreces de correu electrònic verificades recollides de les sessions aprovades d'aquest usuari, p. ex. `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Números de telèfon verificats recollits de les sessions aprovades d'aquest usuari, p. ex. `["+14155551234"]`. features: type: object description: >- 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: type: array items: type: object properties: feature: type: string status: type: string description: >- Les mateixes dades que `features`, com una llista ordenada d'objectes `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Marca de temps de la sessió més recent first_session_at: type: string format: date-time nullable: true description: Marca de temps de la primera sessió last_activity_at: type: string format: date-time nullable: true description: >- Marca de temps de l'activitat més recent d'aquest usuari (sessió, transacció, canvi d'estat, edició de dades, etc.). tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: Etiquetes assignades a aquest usuari created_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.