> ## 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 per llistar llistes de bloqueig i de permesos

> GET /v3/lists/: recupera totes les llistes de bloqueig, permesos i personalitzades de Didit. Filtra per tipus de llista o d'entrada. Sense contractes.



Prompt de l'API de llistes: llistar llistes
        Copia el prompt al porta-retalls



      
      

\<pre>

\`Retrieve every blocklist, allowlist, and custom list in my Didit application through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/

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

Goal:
\- Get a paginated list of all lists for my application so I can find a specific list's uuid, filter by type, or render a picker.

Behavior:
\- Returns the application's active lists, newest first by default. Deleted lists never appear.
\- Includes the system lists Didit provisions (is_system: true): one blocklist per entry type, the "High Risk Countries" custom list, and any system allowlist.
\- Paginated with limit (default 50) and offset. Follow next until it is null.

Query parameters (all optional):
\- list_type: "blocklist" | "allowlist" | "custom".
\- entry_type: face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, country, user, business, key.
\- ordering: created_at or -created_at (default).
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Example call:
curl -X GET "https://verification.didit.me/v3/lists/?list_type=blocklist" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].uuid: list id; use it as list_uuid in the list and entry calls.
\- results[].is_system: true for the lists Didit provisions. System lists cannot be renamed, edited or deleted, but you can add and remove their entries.
\- results[].entry_count, last_entry_added_at: computed over the list's current entries; useful for dashboards.

Failure modes:
\- 400: an unknown list_type or entry_type value, or limit/offset above 1000000.
\- 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.
\- 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

Recupera una llista paginada de totes les llistes actives de la teva aplicació: les llistes del sistema que aprovisiona Didit (una llista de bloqueig per cada tipus d'entrada, la llista **High Risk Countries** i qualsevol llista d'admesos del sistema) i les llistes d'admesos i les llistes personalitzades que has creat. Filtra per `list_type` o `entry_type`, i llegeix els valors d'una llista amb [Entrades de la llista](https://docs.didit.me/ca/management-api/lists/list-entries.md).Consulta [Llistes](https://docs.didit.me/ca/management-api/lists/overview.md) per saber què fa cada tipus de llista durant la verificació i el cribratge de transaccions.


## OpenAPI

````yaml ca/openapi-25.json GET /v3/lists/
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/:
    get:
      tags:
        - Lists
      summary: Llista les llistes
      description: >-
        Retorna les llistes de l'aplicació, les més recents primer: les llistes
        del sistema que Didit proporciona (una llista de bloqueig per tipus
        d'entrada, la llista personalitzada de **High Risk Countries** i
        qualsevol llista d'autorització del sistema) i les llistes
        d'autorització i personalitzades que hagis creat. Filtra amb `list_type`
        i `entry_type`; les llistes suprimides no apareixen mai. Els resultats
        estan paginats amb `limit` i `offset`. Una clau d'API amb àmbit
        requereix `workflows: read`. Consulta
        [Llistes](https://docs.didit.me/ca/management-api/lists/overview) per
        saber què fa cada tipus de llista.
      operationId: list_lists
      parameters:
        - name: list_type
          in: query
          required: false
          description: Només llistes d'aquest tipus.
          schema:
            type: string
            enum:
              - blocklist
              - allowlist
              - custom
        - name: entry_type
          in: query
          required: false
          description: Només llistes d'aquest tipus d'entrada.
          schema:
            type: string
            enum:
              - face
              - document
              - phone
              - email
              - ip_address
              - device_fingerprint
              - wallet_address
              - bank_account
              - country
              - user
              - business
              - key
        - name: ordering
          in: query
          required: false
          description: >-
            Criteri d'ordenació: `-created_at` (del més recent al més antic, per
            defecte) o `created_at` (del més antic al més recent).
          schema:
            type: string
            enum:
              - '-created_at'
              - created_at
            default: '-created_at'
        - name: limit
          in: query
          required: false
          description: >-
            Mida de la pàgina. Per defecte és 50. Un valor superior a 1000000
            retorna `400`; un zero, un valor negatiu o un valor no numèric torna
            al valor per defecte de 50.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
        - name: offset
          in: query
          required: false
          description: >-
            Índex basat en zero del primer element a retornar. És preferible
            seguir `next`. Un valor superior a 1000000 retorna `400`; un valor
            negatiu o no numèric torna a 0 per defecte.
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
      responses:
        '200':
          description: Una pàgina de llistes.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: Nombre total de llistes que coincideixen amb els filtres.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta de la pàgina següent, o `null` a l'última
                      pàgina.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta de la pàgina anterior, o `null` a la primera
                      pàgina.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ComplianceList'
              examples:
                Lists:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - uuid: 22222222-3333-4444-5555-666666666666
                        name: Trusted office IPs
                        description: Office egress ranges
                        list_type: allowlist
                        entry_type: ip_address
                        is_system: false
                        entry_count: 3
                        last_entry_added_at: '2026-10-02T08:15:27.501334Z'
                        created_at: '2026-09-30T13:20:45.889120Z'
                        updated_at: '2026-09-30T13:20:45.889120Z'
                      - 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'
        '400':
          description: Un paràmetre de consulta no és vàlid.
          content:
            application/json:
              examples:
                Unknown list type:
                  value:
                    list_type:
                      - '"denylist" is not a valid choice.'
                Unsupported ordering:
                  value:
                    ordering:
                      - '"name" is not a valid choice.'
                Limit too large:
                  value:
                    - limit must not exceed 1000000.
        '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.
        '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/?list_type=blocklist' \
              -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.lists.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.lists.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.ListAutoPaging(ctx, didit.ListsListParams{})\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.lists().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->lists->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.lists.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.Lists.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
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.