> ## 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. # API Obtener usuario: entidad de usuario del proveedor > Obtén un usuario de Didit por vendor_data con campos de identidad, estado, contadores KYC y mapa de funciones. Identidad KYC persistente, pago por llamada. Prompt para obtener un usuario Copiar el prompt al portapapeles \

\`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.`

\
Pegar en ## Descripción generalDevuelve una única [entidad de usuario](https://docs.didit.me/es/entities/users/overview.md) identificada por `vendor_data`. Las respuestas incluyen `didit_internal_id`, el identificador interno estable de Didit.## Cuándo usarlo- **Consulta** del estado de verificación actual de un usuario: el mapa `features` te da el estado más reciente de cada función en un único objeto. - **Vistas de detalle** en tu propia interfaz: obtén el perfil bajo demanda antes de renderizarlo. - **Puntuación de riesgo**: combina los contadores de sesiones y `features` para puntuar a cada usuario por tu cuenta.## Notas- `vendor_data` en la URL distingue entre mayúsculas y minúsculas. - Devuelve `404` si no existe ningún usuario con ese `vendor_data` en la aplicación. - Los contadores agregados (`session_count`, `approved_count`, `declined_count`, `in_review_count`) se actualizan en tiempo real a medida que se completan las sesiones. - Consulta el [modelo de datos de usuario](https://docs.didit.me/es/entities/users/data-model.md) para ver todos los campos.## PermisosCualquier clave de API activa de la aplicación puede invocar este endpoint. Las claves de API de Didit están **asociadas a la aplicación, no al rol**: los [roles y permisos](https://docs.didit.me/es/console/roles-permissions.md) de la Console (`read:users` y el resto) deciden lo que una *persona* puede hacer en la Console, y no se evalúan para el tráfico de la Management API. Controla quién puede invocar este endpoint controlando quién puede leer la clave de API de la aplicación.## Relacionado- [Descripción general de usuarios](https://docs.didit.me/es/entities/users/overview.md) - [Modelo de datos](https://docs.didit.me/es/entities/users/data-model.md) - [Listar usuarios](https://docs.didit.me/es/management-api/users/list.md) ## OpenAPI ````yaml es/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ón de identidad. Autentícate con el encabezado x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/users/{vendor_data}/: get: tags: - Users summary: Obtener usuario description: >- Obtiene un [usuario](/entities/users) por `vendor_data` (coincidencia exacta). Respecto a la vista de lista, añade `metadata`, `comments` y `updated_at`, y cambia `tags` al formato detallado de vínculos de etiquetas. operationId: get_user parameters: - name: vendor_data in: path required: true schema: type: string description: >- Tu identificador único del usuario: una cadena de texto libre (NO un UUID). Es el mismo valor que enviaste como `vendor_data` al crear la sesión que dio de alta a este usuario por primera vez, y se compara exactamente tal como se envía. example: user-abc-123 responses: '200': description: >- Detalle completo del usuario, que incluye metadatos, registro de comentarios/actividad y datos agregados de sesiones. 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 se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API. content: application/json: examples: Missing credentials: value: detail: >- You must be authenticated with a valid access token to access this endpoint. '403': description: >- Clave de API no válida o revocada, o la clave no puede leer los usuarios de esta aplicación. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: >- No existe ningún usuario con el `vendor_data` proporcionado para esta aplicación. content: application/json: examples: Not found: value: detail: Not found. '429': description: >- Límite de solicitudes superado; espera y reintenta cuando haya pasado el intervalo indicado en `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: >- Detalle completo del usuario. Amplía UserListItem con metadatos, comentarios y updated_at. allOf: - $ref: '#/components/schemas/UserListItem' - type: object properties: metadata: type: object description: >- JSON de metadatos personalizados que adjuntaste a este usuario. Valor predeterminado: `{}`. tags: type: array description: >- Asignaciones de etiquetas. NOTA: en las respuestas de detalle, cada entrada es un objeto de *vínculo* de etiqueta (`{uuid, tag: {...}, added_by_email, added_by_name, created_at}`), a diferencia de la forma plana `{uuid, name, color}` que se usa en las respuestas de listado. items: type: object properties: uuid: type: string format: uuid description: >- UUID de la asignación de etiqueta (no de la etiqueta en sí). 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: >- Valores anteriores de los campos en las entradas PROFILE_UPDATED. new_value: type: object nullable: true description: Nuevos valores de campo para las entradas PROFILE_UPDATED. changed_fields: type: array items: type: string description: >- Nombres de los campos modificados por una entrada PROFILE_UPDATED. metadata: type: object nullable: true mentioned_emails: type: array items: type: string created_at: type: string format: date-time description: >- Registro de actividad y comentarios de este usuario (cambios de estado, ediciones del perfil, notas manuales). updated_at: type: string format: date-time UserListItem: type: object description: Un usuario verificado. properties: didit_internal_id: type: string format: uuid description: UUID interno estable de Didit para este usuario. vendor_data: type: string nullable: true description: >- Tu identificador único de este usuario (el que se envía al crear sesiones). Puede ser null si no se proporcionó ningún identificador propio. display_name: type: string nullable: true description: Nombre visible personalizado que has definido full_name: type: string nullable: true description: Nombre completo extraído de los documentos verificados date_of_birth: type: string format: date nullable: true effective_name: type: string nullable: true description: >- Mejor nombre disponible: display_name si está definido; si no, full_name status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- Estado del ciclo de vida del registro del usuario (NO es un estado de sesión). `ACTIVE` es el valor predeterminado, `FLAGGED` marca al usuario para atención manual y `BLOCKED` impide nuevas sesiones para este `vendor_data`. portrait_image_url: type: string nullable: true description: >- URL prefirmada de la foto de retrato del usuario (caduca al cabo de unas horas) session_count: type: integer description: Número total de sesiones de verificación de este usuario approved_count: type: integer description: Número de sesiones aprobadas declined_count: type: integer description: Número de sesiones rechazadas in_review_count: type: integer description: Número de sesiones en revisión issuing_states: type: array items: type: string description: >- Códigos ISO 3166-1 alpha-3 de los países emisores que figuran en los documentos de identidad aprobados de este usuario, p. ej., `["USA", "ESP"]`. Array vacío si no hay ninguno. approved_emails: type: array items: type: string description: >- Direcciones de correo electrónico verificadas obtenidas de las sesiones aprobadas de este usuario, p. ej., `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Números de teléfono verificados obtenidos de las sesiones aprobadas de este usuario, p. ej., `["+14155551234"]`. features: type: object description: >- Estado agregado por función de todas las sesiones de este usuario. Claves posibles: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Valores posibles: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`. features_list: type: array items: type: object properties: feature: type: string status: type: string description: >- Los mismos datos que `features`, como un array ordenado de objetos `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Marca de tiempo de la sesión más reciente first_session_at: type: string format: date-time nullable: true description: Marca de tiempo de la primera sesión last_activity_at: type: string format: date-time nullable: true description: >- Marca de tiempo de la actividad más reciente de este usuario (sesión, transacción, cambio de estado, edición de datos, etc.). tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: Etiquetas asignadas a este usuario created_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.