> ## 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. # Llistar usuaris API: entitats d'usuari del proveïdor > Recupera totes les entitats d'usuari del proveïdor de la teva aplicació Didit, amb filtres per estat, cerca i data. Gestiona el cicle de vida. Prompt per llistar usuaris Copia el prompt al porta-retalls \

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

\
Enganxa a ## Visió generalRetorna una llista paginada d'[entitats d'usuari](https://docs.didit.me/ca/entities/users/overview.md) de l'aplicació autenticada. Utilitza-la per sincronitzar usuaris amb el teu magatzem, trobar usuaris que necessiten l'atenció d'un analista o cercar per nom visible.## Quan utilitzar-lo- **Sincronització periòdica** de la taula d'usuaris cap a un BI o un magatzem extern. - **Cues d'analistes**: filtra per `status=FLAGGED` o per un `last_activity_at` antic per alimentar una safata de revisió. - **Cercar** usuaris per `display_name`, `full_name` o `vendor_data`.## Filtres i paginació| Paràmetre de consulta | Descripció | | - | - | | `status` | Filtra per `ACTIVE`, `FLAGGED` o `BLOCKED`. | | `search` | Coincidència parcial a `vendor_data`, `display_name`, `full_name`, correus electrònics i telèfons. | | `country_code` | Filtra per `issuing_states` (ISO 3166-1 alpha-3). | | `created_after`, `created_before` | Finestra de data de creació (ISO 8601). | | `last_activity_after`, `last_activity_before` | Finestra d'activitat. | | `page_size` | 1–200. Per defecte: 50. | | `cursor` | Cursor de paginació retornat a la resposta anterior. |## Notes- Cada element de la resposta inclou `didit_internal_id`. `vendor_data` pot ser `null` quan la sessió o la transacció original no n'ha proporcionat cap. - Aquest endpoint pagina mitjançant cursor: conserva el cursor `next` entre crides i atura't quan `next` estigui buit. - Consulta el [Model de dades d'usuari](https://docs.didit.me/ca/entities/users/data-model.md) per veure tots els camps d'una fila d'usuari.## PermisosQualsevol clau d'API activa de l'aplicació pot cridar aquest endpoint. Les claus d'API de Didit tenen **àmbit d'aplicació, no de rol**: els [rols i permisos](https://docs.didit.me/ca/console/roles-permissions.md) de la Console (`list:users` i la resta) determinen què pot fer una *persona* a la Console, i no s'avaluen per al trànsit de l'API de gestió. Controla qui pot cridar aquest endpoint controlant qui pot llegir la clau d'API de l'aplicació.## Relacionats- [Visió general dels usuaris](https://docs.didit.me/ca/entities/users/overview.md) - [Obtenir un usuari](https://docs.didit.me/ca/management-api/users/get.md) - [Operacions d'usuari](https://docs.didit.me/ca/entities/users/operations.md) ## OpenAPI ````yaml ca/openapi-25.json GET /v3/users/ 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/: get: tags: - Users summary: Llista els usuaris description: >- Llista els [usuaris](/entities/users) que Didit reuneix a partir de sessions de KYC que comparteixen el mateix `vendor_data` (cadena de text lliure, NO pas un UUID), a més dels usuaris creats mitjançant l'API. Paginat, ordenat per `last_session_at` descendent. Aquest endpoint no admet paràmetres de filtre ni de cerca; obtén les pàgines i filtra al costat del client. operationId: list_users parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: >- Mida de la pàgina. Per defecte és 50 si s'omet. No hi ha cap màxim imposat, però mantén les pàgines petites per reduir la latència. - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: >- Desplaçament basat en zero del primer registre a retornar. És preferible seguir l'URL `next` de la pàgina anterior abans que calcular-ho manualment. responses: '200': description: >- Llista paginada d'usuaris amb estat de verificació, recomptes de sessions i desglossament de funcionalitats. content: application/json: schema: type: object properties: count: type: integer description: >- Nombre de files coincidents: exacte fins a 100, limitat a 100 a partir d'aquí per motius de rendiment. No el facis servir per detectar la darrera pàgina; confia en canvi que `next` sigui `null`. next: type: string nullable: true description: >- URL absoluta de la pàgina següent, o `null` a l'última pàgina. previous: type: string nullable: true description: >- URL absoluta de la pàgina anterior, o `null` a 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 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: >- La clau no pot llistar usuaris per a 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. '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/?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 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.