> ## 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 para listar usuarios: entidades User del proveedor > Obtén todas las entidades User de tu aplicación de Didit con filtros por estado, búsqueda y fecha. Gestiona su ciclo de vida por API. Prompt para listar usuarios Copiar el prompt al portapapeles \

\`Goal: Page through Didit User entities for an application and consume them in your backend.

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

Query params (all optional):
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices, NOT the session enum).
\- search: free-text over vendor_data, display_name, full_name, approved_emails, approved_phones.
\- country: ISO 3166-1 alpha-3 (e.g. "USA", "ESP") — filters by issuing country of approved documents.
\- limit: integer, 1–200, default 50.
\- offset: integer, 0+, default 0. Prefer following the "next" URL from the previous page.

curl:
curl -X GET 'https://verification.didit.me/v3/users/?limit=50&status=ACTIVE' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (envelope):
\{
"count": ,
"next": ,
"previous": ,
"results": [ UserListItem, ... ]
}

UserListItem key fields: didit_internal_id (UUID), vendor_data (string, may be null), display_name, full_name, effective_name, status, portrait_image_url, session_count, approved_count, declined_count, in_review_count, issuing_states, approved_emails, approved_phones, features (map of feature -> "Approved" | "Declined" | "In Review" | ...), features_list, last_session_at, first_session_at, tags, created_at. See /reference/data-models for the full shape.

Notes:
\- Ordered by last_session_at desc (most recently active first).
\- Deleted users are not returned.
\- vendor_data is a free-form client-supplied string, NOT a UUID. It may be null when the originating session did not provide one.

Pagination loop:
url = 'https://verification.didit.me/v3/users/?limit=200&status=ACTIVE'
while url:
r = requests.get(url, headers={'x-api-key': API_KEY})
r.raise_for_status()
page = r.json()
for user in page['results']:
    ...handle user...
url = page['next']

Failure modes (all return {"detail": "..."} unless noted):
\- 401 — missing or revoked x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 429 — rate-limited. Honour Retry-After header.

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

\
Pegar en ## Descripción generalDevuelve una lista paginada de [entidades de usuario](https://docs.didit.me/es/entities/users/overview.md) de la aplicación autenticada. Úsalo para sincronizar usuarios con tu data warehouse, encontrar usuarios que requieren la atención de un analista o buscar por nombre para mostrar.## Cuándo usarlo- **Sincronización periódica** de tu tabla de usuarios con herramientas externas de BI o con un data warehouse externo. - **Colas de analistas**: filtra por `status=FLAGGED` o por un `last_activity_at` desactualizado para alimentar una bandeja de revisión. - **Buscar** usuarios por `display_name`, `full_name` o `vendor_data`.## Filtros y paginación| Parámetro de consulta | Descripción | | - | - | | `status` | Filtra por `ACTIVE`, `FLAGGED` o `BLOCKED`. | | `search` | Coincidencia de subcadena en `vendor_data`, `display_name`, `full_name`, correos electrónicos y teléfonos. | | `country_code` | Filtra por `issuing_states` (ISO 3166-1 alpha-3). | | `created_after`, `created_before` | Intervalo de fechas de creación (ISO 8601). | | `last_activity_after`, `last_activity_before` | Intervalo de actividad. | | `page_size` | De 1 a 200. Valor predeterminado: 50. | | `cursor` | Cursor de paginación devuelto en la respuesta anterior. |## Notas- Cada elemento de la respuesta incluye `didit_internal_id`. `vendor_data` puede ser `null` cuando la sesión o transacción original no lo proporcionó. - Este endpoint se pagina mediante cursor: guarda el cursor `next` entre llamadas y detente cuando `next` esté vacío. - Consulta el [modelo de datos de usuario](https://docs.didit.me/es/entities/users/data-model.md) para ver todos los campos de una fila de usuario.## PermisosCualquier clave de API activa de la aplicación puede llamar a este endpoint. Las claves de API de Didit tienen **alcance de aplicación, no de rol**: los [roles y permisos](https://docs.didit.me/es/console/roles-permissions.md) de la Console (`list:users` y los demás) determinan 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 llamar a 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) - [Obtener usuario](https://docs.didit.me/es/management-api/users/get.md) - [Operaciones de usuario](https://docs.didit.me/es/entities/users/operations.md) ## OpenAPI ````yaml es/openapi-25.json GET /v3/users/ 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/: get: tags: - Users summary: Listar usuarios description: >- Lista los [usuarios](/entities/users) que Didit agrupa a partir de las sesiones KYC que comparten el mismo `vendor_data` (cadena de texto libre, NO un UUID), además de los usuarios creados mediante la API. Paginado y ordenado por `last_session_at` en orden descendente. Este endpoint no admite parámetros de filtrado ni de búsqueda: obtén las páginas y filtra en el cliente. operationId: list_users parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: >- Tamaño de página. Si se omite, el valor predeterminado es 50. No hay un máximo obligatorio, pero mantén las páginas pequeñas para reducir la latencia. - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: >- Desplazamiento, empezando en cero, del primer registro que se devuelve. Es preferible seguir la URL `next` de la página anterior en lugar de calcularlo a mano. responses: '200': description: >- Lista paginada de usuarios con su estado de verificación, número de sesiones y desglose por función. content: application/json: schema: type: object properties: count: type: integer description: >- Número de filas coincidentes: exacto hasta 100, limitado a 100 a partir de ahí por rendimiento. No lo uses para detectar la última página; comprueba en su lugar que `next` sea `null`. next: type: string nullable: true description: >- URL absoluta de la página siguiente, o `null` en la última página. previous: type: string nullable: true description: >- URL absoluta de la página anterior, o `null` en la primera página. results: type: array items: $ref: '#/components/schemas/UserListItem' examples: Example: value: count: 2 next: null previous: null results: - 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 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 name: VIP color: '#2567FF' created_at: '2025-06-01T08:00:00Z' - didit_internal_id: 6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b vendor_data: null display_name: Jane S. full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' effective_name: Jane S. status: FLAGGED portrait_image_url: null session_count: 1 approved_count: 0 declined_count: 0 in_review_count: 1 issuing_states: [] approved_emails: [] approved_phones: [] features: ID_VERIFICATION: In Review features_list: - feature: ID_VERIFICATION status: In Review last_session_at: '2025-06-20T14:00:00Z' last_activity_at: '2025-06-20T14:05:00Z' first_session_at: '2025-06-20T14:00:00Z' tags: [] created_at: '2025-06-20T14:00: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: >- La clave no puede listar 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. '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/?limit=50' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.users.list(): print(item) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.users.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.users().list()) { System.out.println(item); } - lang: php label: PHP source: |- users->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.users.list.auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.Users.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: 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.