> ## 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 Get List: recupera lista di compliance

> GET /v3/lists/{list_uuid}/: recupera i dettagli di una blocklist, allowlist o lista personalizzata Didit, incluso il numero di voci e i metadati.



Prompt API per ottenere la lista
        Copia il prompt negli appunti



      
      

\<pre>

\`Fetch a single Didit list's metadata through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/{list_uuid}/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: read.

Goal:
\- Retrieve the details of a specific list: name, description, list_type, entry_type, is_system, entry_count, last_entry_added_at.
\- Use this to render a list-detail view or to confirm a list still exists before adding entries.

Path parameter:
\- list_uuid: the list UUID returned by GET /v3/lists/ or POST /v3/lists/.

Example call:
curl -X GET "https://verification.didit.me/v3/lists/{list_uuid}/" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- list_type: "blocklist" | "allowlist" | "custom" (drives what a match does).
\- entry_type: decides how values are validated and which data is matched.
\- is_system: true for the lists Didit provisions (one blocklist per entry type, the "High Risk Countries" list, any system allowlist). These cannot be renamed, edited or deleted.
\- entry_count, last_entry_added_at: computed over the list's current entries.

This endpoint returns the list metadata only. To fetch entries, call GET /v3/lists/{list_uuid}/entries/.

Failure modes:
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: read.
\- 404: no list with this UUID in this application, or it was deleted ({ "detail": "No List matches the given query." }).
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Incolla in

Recupera i dettagli di una lista, incluso il numero di voci e la data in cui è stata aggiunta la voce più recente. Una lista di un'altra applicazione, oppure una lista eliminata, restituisce `404`.Per leggere i valori della lista, usa [Voci della lista](https://docs.didit.me/it/management-api/lists/list-entries.md).


## OpenAPI

````yaml it/openapi-25.json GET /v3/lists/{list_uuid}/
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/lists/{list_uuid}/:
    get:
      tags:
        - Lists
      summary: Recupera una lista
      description: >-
        Restituisce una lista dell'applicazione indicando il relativo conteggio
        delle voci e quando è stata aggiunta la voce più recente. Una lista di
        un'altra applicazione, o una che è stata eliminata, restituisce `404`.
        Questo restituisce solo la lista: leggine i valori con [Elenca le voci
        della
        lista](https://docs.didit.me/it/management-api/lists/list-entries). Una
        chiave API con ambito limitato richiede `workflows: read`.
      operationId: get_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: UUID della lista, come restituito da List lists o Create a list.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      responses:
        '200':
          description: La lista.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceList'
              examples:
                System face blocklist:
                  value:
                    uuid: 11111111-2222-3333-4444-555555555555
                    name: Face Blocklist
                    description: >-
                      Blocked biometric faces. When a face matching an entry in
                      this list is detected during liveness verification, the
                      session will be automatically declined.
                    list_type: blocklist
                    entry_type: face
                    is_system: true
                    entry_count: 12
                    last_entry_added_at: '2026-10-09T16:42:03.118204Z'
                    created_at: '2026-01-14T10:02:11.402917Z'
                    updated_at: '2026-01-14T10:02:11.402917Z'
        '401':
          description: >-
            La chiave API con ambito è scaduta. Altri errori di autenticazione
            restituiscono `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            L'intestazione `x-api-key` è mancante (una chiave errata, revocata o
            scaduta riceve `401`), oppure una chiave API con ambito limitato non
            dispone di `workflows: read` o viene utilizzata da un indirizzo IP
            non presente nella sua allowlist.
          content:
            application/json:
              examples:
                Missing or invalid API key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without workflows access:
                  value:
                    detail: This API key has no read access to workflows.
        '404':
          description: >-
            Nessuna lista con questo UUID esiste nell'applicazione della chiave
            API, oppure è stata eliminata.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '429':
          description: >-
            Il limite di lettura condiviso di 600 richieste al minuto per chiave
            API è stato superato. Rispetta `Retry-After` prima di riprovare.
          content:
            application/json:
              examples:
                Rate limited:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.retrieve(
                "11111111-2222-3333-4444-555555555555",
            )
            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.lists.retrieve("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\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.lists().retrieve("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->lists->retrieve('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.lists.retrieve("11111111-2222-3333-4444-555555555555")

            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.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    ComplianceList:
      type: object
      description: Una blocklist, allowlist o lista personalizzata di un'applicazione.
      required:
        - uuid
        - name
        - description
        - list_type
        - entry_type
        - is_system
        - entry_count
        - last_entry_added_at
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Identificatore della lista. Utilizzalo come `list_uuid` negli
            endpoint di lista e voci, e come valore di una condizione di regola
            di workflow o transazione con `value_type: "list"`.
        name:
          type: string
          maxLength: 255
          description: Nome della lista, univoco tra le liste dell'applicazione.
        description:
          type: string
          description: Descrizione in formato testo libero. Stringa vuota se non impostata.
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist`: una corrispondenza rifiuta la sessione o la transazione
            (solo liste di sistema, una per tipo di voce). `allowlist`: gli
            elementi corrispondenti sono attendibili, ad esempio un'allowlist
            dei volti salta l'azione per volto duplicato; non sovrascrive mai
            una corrispondenza con la blocklist. `custom`: utilizzato nelle
            condizioni delle regole del workflow e delle transazioni
            (`value_type: "list"`).
        entry_type:
          type: string
          enum:
            - face
            - document
            - phone
            - email
            - ip_address
            - device_fingerprint
            - wallet_address
            - bank_account
            - country
            - user
            - business
            - key
          description: >-
            Cosa contiene la lista: `face`, `document` (numero del documento),
            `phone`, `email`, `ip_address` (indirizzo o intervallo CIDR),
            `device_fingerprint`, `wallet_address`, `bank_account`, `country`
            (ISO 3166-1 alpha-3), `user` o `business` (il tuo `vendor_data`),
            oppure `key` (qualsiasi stringa). Determina come vengono convalidati
            e confrontati i valori delle voci.
        is_system:
          type: boolean
          description: >-
            `true` per le liste predisposte da Didit: una blocklist per tipo di
            voce (`face`, `document`, `phone`, `email`, `ip_address`,
            `device_fingerprint`, `wallet_address`, `bank_account`, `user`,
            `business`), la lista personalizzata **High Risk Countries** e le
            allowlist di sistema. Le liste di sistema non possono essere
            rinominate, modificate o eliminate; puoi aggiungerne ed eliminarne
            le voci.
        entry_count:
          type: integer
          minimum: 0
          description: Numero di voci attualmente presenti nella lista.
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quando è stata aggiunta la voce corrente più recente. `null` per una
            lista vuota.
        created_at:
          type: string
          format: date-time
          description: Quando la lista è stata creata.
        updated_at:
          type: string
          format: date-time
          description: Quando la lista è stata aggiornata l'ultima volta.
  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.