> ## 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 elenco utenti: entità User del fornitore

> Recupera tutte le entità User del fornitore per la tua applicazione Didit, filtrate per stato, ricerca e data. Gestione programmatica degli utenti.



Prompt per l'elenco utenti
        Copia il prompt negli appunti



      
      

\<pre>

\`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: <DIDIT_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": <int — exact up to 100, capped above; pagination still works via "next">,
"next": <URL of next page or null>,
"previous": <URL of previous page or null>,
"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.`

\</pre>



      
      

Incolla in

## PanoramicaRestituisce un elenco paginato di [entità Utente](https://docs.didit.me/it/entities/users/overview.md) per l'applicazione autenticata. Usalo per sincronizzare gli utenti con il tuo data warehouse, individuare gli utenti che richiedono l'attenzione di un analista o cercare per nome visualizzato.## Quando usarlo- **Sincronizzazione periodica** della tabella degli utenti verso uno strumento BI o un data warehouse esterno.
- **Code per gli analisti**: filtra per `status=FLAGGED` o per `last_activity_at` non aggiornato, per alimentare una coda di revisione.
- **Ricerca** di utenti per `display_name`, `full_name` o `vendor_data`.## Filtri e paginazione| Parametro di query | Descrizione |
| - | - |
| `status` | Filtra per `ACTIVE`, `FLAGGED` o `BLOCKED`. |
| `search` | Corrispondenza parziale su `vendor_data`, `display_name`, `full_name`, email e numeri di telefono. |
| `country_code` | Filtra per `issuing_states` (ISO 3166-1 alpha-3). |
| `created_after`, `created_before` | Intervallo di date di creazione (ISO 8601). |
| `last_activity_after`, `last_activity_before` | Intervallo di attività. |
| `page_size` | Da 1 a 200. Predefinito: 50. |
| `cursor` | Cursore di paginazione restituito nella risposta precedente. |## Note- Ogni elemento della risposta include `didit_internal_id`. `vendor_data` può essere `null` quando la sessione o la transazione originale non ne ha fornito uno.
- Questo endpoint pagina tramite cursore: conserva il cursore `next` tra una chiamata e l'altra e interrompi la paginazione quando `next` è vuoto.
- Consulta il [modello dati dell'utente](https://docs.didit.me/it/entities/users/data-model.md) per tutti i campi di una riga utente.## AutorizzazioniQualsiasi chiave API attiva dell'applicazione può chiamare questo endpoint. Le chiavi API di Didit sono **limitate all'applicazione, non al ruolo**: i [ruoli e le autorizzazioni](https://docs.didit.me/it/console/roles-permissions.md) della Console (`list:users` e gli altri) stabiliscono cosa una *persona* può fare nella Console e non vengono valutati per il traffico della Management API. Per controllare chi può chiamare questo endpoint, controlla chi può leggere la chiave API dell'applicazione.## Correlati- [Panoramica degli utenti](https://docs.didit.me/it/entities/users/overview.md)
- [Recupera utente](https://docs.didit.me/it/management-api/users/get.md)
- [Operazioni sugli utenti](https://docs.didit.me/it/entities/users/operations.md)


## OpenAPI

````yaml it/openapi-25.json GET /v3/users/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API di verifica dell'identità. Autenticati con l'intestazione x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/users/:
    get:
      tags:
        - Users
      summary: Elenca gli utenti
      description: >-
        Elenca gli [utenti](/entities/users) aggregati da Didit a partire dalle
        sessioni KYC che condividono lo stesso `vendor_data` (stringa a formato
        libero, NON un UUID), oltre agli utenti creati tramite API. Paginato,
        ordinato per `last_session_at` decrescente. Questo endpoint non supporta
        parametri di filtro o ricerca: recupera le pagine e applica i filtri sul
        client.
      operationId: list_users
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
          description: >-
            Dimensione della pagina. Se omessa, il valore predefinito è 50. Non
            esiste un massimo imposto, ma mantieni le pagine piccole per ridurre
            la latenza.
        - name: offset
          in: query
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
          description: >-
            Offset in base zero del primo record da restituire. È preferibile
            seguire l'URL `next` della pagina precedente invece di calcolarlo
            manualmente.
      responses:
        '200':
          description: >-
            Elenco impaginato degli utenti con stato di verifica, conteggio
            delle sessioni e riepilogo delle funzionalità.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Numero di righe corrispondenti: esatto fino a 100, con
                      limite massimo di 100 oltre tale soglia per motivi di
                      prestazioni. Non utilizzarlo per rilevare l'ultima pagina;
                      fai invece affidamento sul fatto che `next` sia `null`.
                  next:
                    type: string
                    nullable: true
                    description: >-
                      URL assoluto della pagina successiva, o `null` sull'ultima
                      pagina.
                  previous:
                    type: string
                    nullable: true
                    description: >-
                      URL assoluto della pagina precedente, o `null` sulla prima
                      pagina.
                  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://<media-host>/...
                        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: >-
            Nessuna credenziale fornita. Le richieste ai percorsi `/v3/users/*`
            senza un'intestazione `x-api-key` (o token `Authorization: Bearer`)
            vengono rifiutate dal middleware di autenticazione prima di
            raggiungere 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 chiave non può elencare gli utenti per questa applicazione. Una
            chiave mancante restituisce `403`; una chiave errata, revocata o
            scaduta restituisce `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: >-
            Limite di frequenza superato; rallenta e riprova dopo l'intervallo
            indicato in `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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->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 utente verificato.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interno stabile di Didit per questo utente.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Il tuo identificatore univoco per questo utente (passato durante la
            creazione delle sessioni). Può essere null se non è stato fornito
            alcun identificatore del fornitore.
        display_name:
          type: string
          nullable: true
          description: Nome visualizzato personalizzato impostato da te
        full_name:
          type: string
          nullable: true
          description: Nome completo estratto dai documenti verificati
        date_of_birth:
          type: string
          format: date
          nullable: true
        effective_name:
          type: string
          nullable: true
          description: >-
            Miglior nome disponibile: display_name se impostato, altrimenti
            full_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Stato del ciclo di vita del record utente (NON uno stato della
            sessione). `ACTIVE` è il valore predefinito, `FLAGGED` contrassegna
            l'utente per una verifica manuale, `BLOCKED` impedisce nuove
            sessioni per questo `vendor_data`.
        portrait_image_url:
          type: string
          nullable: true
          description: >-
            URL prefirmato della foto ritratto dell'utente (scade dopo alcune
            ore)
        session_count:
          type: integer
          description: Numero totale di sessioni di verifica per questo utente
        approved_count:
          type: integer
          description: Numero di sessioni approvate
        declined_count:
          type: integer
          description: Numero di sessioni rifiutate
        in_review_count:
          type: integer
          description: Numero di sessioni in revisione
        issuing_states:
          type: array
          items:
            type: string
          description: >-
            Codici ISO 3166-1 alpha-3 dei paesi di emissione rilevati nei
            documenti d'identità approvati di questo utente, ad es. `["USA",
            "ESP"]`. Array vuoto se assenti.
        approved_emails:
          type: array
          items:
            type: string
          description: >-
            Indirizzi email verificati raccolti dalle sessioni approvate di
            questo utente, ad es. `["john@example.com"]`.
        approved_phones:
          type: array
          items:
            type: string
          description: >-
            Numeri di telefono verificati raccolti dalle sessioni approvate di
            questo utente, ad es. `["+14155551234"]`.
        features:
          type: object
          description: >-
            Stato aggregato per funzionalità in tutte le sessioni di questo
            utente. Chiavi possibili: `ID_VERIFICATION`, `NFC`, `LIVENESS`,
            `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`,
            `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`.
            Valori possibili: `Approved`, `Declined`, `In Review`, `Not
            Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Gli stessi dati di `features`, sotto forma di array ordinato di
            oggetti `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp della sessione più recente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp della prima sessione
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Timestamp dell'attività più recente su questo utente (sessione,
            transazione, cambio di stato, modifica dei dati, ecc.).
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Tag assegnati a questo utente
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La chiave API della tua applicazione, da Developers -> API keys nella
        Business Console. La chiave primaria ha accesso completo. Una chiave con
        nome può avere un ambito definito: nessuno, lettura o scrittura per
        risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco
        di indirizzi IP e a una data di scadenza. 401 indica che la chiave è
        errata, revocata o scaduta; 403 indica che non è stata inviata alcuna
        chiave, che la chiave non ha accesso a questa risorsa o azione, oppure
        che la richiesta proviene da un indirizzo non incluso nel suo elenco IP;
        404 su una route di sessione indica che la sessione non rientra nei
        workflow o negli stati previsti dalla chiave. Una chiave senza accesso
        ai media riceve gli URL di immagini, video e PDF come null, e una chiave
        senza permessi di scrittura sulle sessioni riceve link e token di
        sessione come null. Consulta https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.