> ## 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.

# Obtenir llista API: consultar una llista de compliment

> GET /v3/lists/{list_uuid}/: consulta els detalls d'una llista de Didit (bloqueig, permesos o personalitzada), amb el nombre d'entrades.



Prompt de l'API per obtenir una llista
        Copia el prompt al porta-retalls



      
      

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



      
      

Enganxa a

Obtén els detalls d'una llista, incloent-hi el nombre d'entrades i quan s'hi va afegir l'entrada més recent. Una llista d'una altra aplicació, o una llista que s'ha eliminat, retorna `404`.Per llegir els valors de la llista, fes servir [Entrades de la llista](https://docs.didit.me/ca/management-api/lists/list-entries.md).


## OpenAPI

````yaml ca/openapi-25.json GET /v3/lists/{list_uuid}/
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/lists/{list_uuid}/:
    get:
      tags:
        - Lists
      summary: Obtenir una llista
      description: >-
        Retorna una llista de l'aplicació amb el seu recompte d'entrades i quan
        es va afegir la seva entrada més recent. Una llista d'una altra
        aplicació, o una que s'hagi eliminat, retorna `404`. Això només retorna
        la llista: llegeix els seus valors amb [Llistar entrades de la
        llista](https://docs.didit.me/ca/management-api/lists/list-entries). Una
        clau d'API amb àmbit restringit requereix `workflows: read`.
      operationId: get_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID de la llista, tal com el retorna Llistar llistes o Crear una
            llista.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      responses:
        '200':
          description: La llista.
          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 clau d'API amb abast ha caducat. Altres fallades d'autenticació
            retornen `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falta la capçalera `x-api-key` (una clau incorrecta, revocada o
            caducada rep un `401`), o una clau d'API amb àmbit no té `workflows:
            read` o s'utilitza des d'una adreça fora de la seva llista
            d'admesos.
          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: >-
            No existeix cap llista amb aquest UUID a l'aplicació de la clau
            d'API, o s'ha suprimit.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '429':
          description: >-
            S'ha superat el límit compartit de lectura de 600 sol·licituds per
            minut per clau d'API. Respecta `Retry-After` abans de reintentar.
          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 llista de bloqueig, llista de permesos o llista personalitzada d'una
        aplicació.
      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: >-
            Identificador de la llista. Utilitza'l com a `list_uuid` als
            endpoints de llistes i entrades, i com a valor d'una condició de
            regla de flux de treball o de transacció amb `value_type: "list"`.
        name:
          type: string
          maxLength: 255
          description: Nom de la llista, únic entre les llistes de l'aplicació.
        description:
          type: string
          description: Descripció de text lliure. Cadena buida si no s'ha definit.
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist`: una coincidència rebutja la sessió o la transacció
            (només llistes del sistema, una per tipus d'entrada). `allowlist`:
            els elements coincidents són de confiança; per exemple, una llista
            d'autorització facial omet l'acció de detecció de cares duplicades;
            mai no anul·la una coincidència amb una llista de bloqueig.
            `custom`: s'utilitza en condicions de regles de fluxos de treball i
            transaccions (`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: >-
            Què conté la llista: `face`, `document` (número de document),
            `phone`, `email`, `ip_address` (adreça o rang CIDR),
            `device_fingerprint`, `wallet_address`, `bank_account`, `country`
            (ISO 3166-1 alpha-3), `user` o `business` (el teu `vendor_data`), o
            `key` (qualsevol cadena). Decideix com es validen i es comparen els
            valors de les entrades.
        is_system:
          type: boolean
          description: >-
            `true` per a les llistes que Didit aprovisiona: una llista de
            bloqueig per tipus d'entrada (`face`, `document`, `phone`, `email`,
            `ip_address`, `device_fingerprint`, `wallet_address`,
            `bank_account`, `user`, `business`), la llista personalitzada **High
            Risk Countries** i les llistes d'admesos del sistema. Les llistes
            del sistema no es poden reanomenar, editar ni suprimir; pots afegir
            i suprimir les seves entrades.
        entry_count:
          type: integer
          minimum: 0
          description: Nombre d'entrades actualment a la llista.
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quan es va afegir l'entrada actual més recent. `null` per a una
            llista buida.
        created_at:
          type: string
          format: date-time
          description: Quan es va crear la llista.
        updated_at:
          type: string
          format: date-time
          description: Quan es va actualitzar la llista per darrera vegada.
  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.