> ## 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 d'entrades de llistes de bloqueig i permesos

> Didit: GET /v3/lists/{list_uuid}/entries/ recupera entrades paginades de llistes de bloqueig, permesos o personalitzades, amb cerca. Preu per crida.



Prompt de l'API d'entrades de llista
        Copia el prompt al porta-retalls



      
      

\<pre>

\`Retrieve paginated entries from a Didit list through the Management API.

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

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

Goal:
\- Browse, search, or export the entries inside a specific list (blocklist, allowlist, or custom).

Path parameter:
\- list_uuid: the list UUID from GET /v3/lists/.

Query parameters (all optional):
\- search: case-insensitive text that value or display_label must contain.
\- reference_session_id: only the entries taken from this person verification session (for example, to see which of its faces are already in the face blocklist). Must be a session UUID.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Behavior:
\- Current entries only, newest first.
\- Image URLs in metadata (reference_image_url, front_image_url) are short-lived signed URLs, issued again on every call. A scoped key without media: read gets null in their place.

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

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].uuid: entry id; use it as entry_uuid in DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/.
\- results[].value: the listed value (phone number in E.164, email, document number, IP or CIDR range, wallet address, country code, vendor_data, or a face UUID on face lists). Matching is case-insensitive.
\- results[].display_label, comment: labels and notes.
\- results[].added_by: "api" (an API key), a console user's email or "console", "system" (entries Didit provisions), or "rule" (a transaction rule action).
\- results[].reference_session_id / reference_session_number / reference_session_type: set when the entry was taken from a verification session; reference_session_type is "kyc" or "kyb".
\- results[].reference_object_uuid + metadata.reference_type: the record the entry stands for. metadata.reference_type, when you set it, says whether reference_object_uuid is a "transaction", a "vendor_user" or a "vendor_business".
\- results[].metadata: may include document context (full_name, issuing_state, document_type, document_number), face image URLs, and, for faces from a document-capture selfie, face_image_source and reference_node_id.

Failure modes:
\- 400: reference_session_id is not a valid UUID, 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.
\- 404: no list with this UUID in this application, or it was deleted ({ "detail": "List not found." }).
\- 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 les entrades d'una llista, de la més recent a la més antiga, amb cerca opcional. `search` coincideix amb una part del valor o de l'etiqueta d'una entrada, sense distingir majúscules de minúscules. `reference_session_id` limita els resultats a les entrades obtingudes d'una sessió de verificació concreta. En una llista de cares, `metadata.face_image_source` indica a quina de les cares de la sessió correspon cada entrada (`liveness` si el camp no hi és).Les entrades facials i de documents contenen URL d'imatges a `metadata` que caduquen poc després de la crida. Torna a obtenir les entrades per obtenir URL actualitzades en lloc d'emmagatzemar-les. Una clau d'API sense **media: read** rep `null` per a aquestes URL.


## OpenAPI

````yaml ca/openapi-25.json GET /v3/lists/{list_uuid}/entries/
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}/entries/:
    get:
      tags:
        - Lists
      summary: Llista les entrades de la llista
      description: >-
        Retorna les entrades actuals d'una llista, les més recents primer.
        `search` cerca coincidències amb part del `value` o `display_label`
        d'una entrada sense distingir majúscules de minúscules, i
        `reference_session_id` limita els resultats a les entrades preses d'una
        sessió de verificació de persona. Les URL d'imatge a `metadata` són URL
        signades de curta durada que s'emeten de nou a cada crida; una clau
        d'API amb àmbit sense `media: read` rep `null` al seu lloc. Una clau
        d'API amb àmbit requereix `workflows: read`.
      operationId: list_list_entries
      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
        - name: search
          in: query
          required: false
          description: >-
            Text que no distingeix majúscules de minúscules que ha de contenir
            el `value` o el `display_label` de l'entrada.
          schema:
            type: string
        - name: reference_session_id
          in: query
          required: false
          description: >-
            Només les entrades extretes d'aquesta sessió de verificació de
            persona, per exemple per veure quines de les seves cares ja estan
            llistades.
          schema:
            type: string
            format: uuid
        - 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 d'entrades, les més recents primer.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: Nombre total d'entrades 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/ComplianceListEntry'
              examples:
                Entries:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - uuid: bbbbbbbb-cccc-dddd-eeee-ffffffffffff
                        value: X1234567
                        display_label: Jane Doe - X1234567
                        comment: ''
                        added_by: api
                        reference_session_id: 33333333-4444-5555-6666-777777777777
                        reference_session_number: 1042
                        reference_session_type: kyc
                        reference_object_uuid: 66666666-7777-8888-9999-000000000000
                        metadata:
                          full_name: Jane Doe
                          issuing_state: ESP
                          document_type: ID
                          region: ''
                          document_number: X1234567
                        created_at: '2026-10-12T10:06:12.774915Z'
                      - uuid: eeeeeeee-ffff-0000-1111-222222222222
                        value: y7654321
                        display_label: ''
                        comment: Reported by a partner
                        added_by: api
                        reference_session_id: null
                        reference_session_number: null
                        reference_session_type: null
                        reference_object_uuid: null
                        metadata: null
                        created_at: '2026-10-03T07:48:30.552810Z'
        '400':
          description: Un paràmetre de consulta no és vàlid.
          content:
            application/json:
              examples:
                Invalid session id:
                  value:
                    reference_session_id:
                      - Must be a valid UUID.
                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.
        '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: List not found.
        '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/entries/?search=example.com'
            \
              -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.entries.list(
                "11111111-2222-3333-4444-555555555555",
            ):
                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.entries.list("11111111-2222-3333-4444-555555555555")) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.Entries.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesListParams{})\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().entries().list("11111111-2222-3333-4444-555555555555"))
            {
                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->entries->list('11111111-2222-3333-4444-555555555555')
            as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.lists.entries.list("11111111-2222-3333-4444-555555555555").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.Entries.ListAsync("11111111-2222-3333-4444-555555555555"))

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    ComplianceListEntry:
      type: object
      description: Un valor en una llista.
      required:
        - uuid
        - value
        - display_label
        - comment
        - added_by
        - reference_session_id
        - reference_session_number
        - reference_session_type
        - reference_object_uuid
        - metadata
        - created_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Identificador de l'entrada. Utilitza'l com a `entry_uuid` a
            l'operació «Eliminar una entrada de llista».
        value:
          type: string
          description: >-
            El valor llistat: un número de telèfon en E.164, una adreça de
            correu electrònic, un número de document, una adreça IP o rang CIDR,
            una empremta digital de dispositiu, una adreça de cartera, un compte
            bancari, un codi de país ISO 3166-1 alfa-3, un `vendor_data`,
            qualsevol cadena en una llista `key`, o l'UUID de la cara
            emmagatzemada en una llista de cares. Els valors que envies
            s'emmagatzemen en minúscules, excepte els números de telèfon i els
            codis de país. La coincidència no distingeix entre majúscules i
            minúscules.
        display_label:
          type: string
          nullable: true
          maxLength: 512
          description: >-
            Etiqueta fàcil de llegir. Didit l'emplena per a entrades extretes
            d'una sessió (per exemple, el nom del titular i el número de
            document) quan no n'envies cap.
        comment:
          type: string
          description: Nota de text lliure. Cadena buida si no s'ha definit.
        added_by:
          type: string
          nullable: true
          description: >-
            Qui ha afegit l'entrada: `api` (una clau d'API), l'adreça de correu
            electrònic d'un usuari de la consola o `console`, `system` o
            `migration` (entrades creades per Didit) o `rule` (una acció de
            regla de transacció o de monitoratge).
        reference_session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Sessió de verificació d'on s'ha extret l'entrada. `null` quan
            l'entrada s'ha afegit per valor.
        reference_session_number:
          type: integer
          nullable: true
          description: >-
            Número d'aquesta sessió en l'àmbit de l'aplicació, tal com es mostra
            a la consola.
        reference_session_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - null
          description: >-
            `kyc` per a una sessió de verificació de persona, `kyb` per a una
            sessió de verificació d'empresa, `null` quan no hi ha cap sessió.
        reference_object_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            El registre que representa l'entrada: el registre de rostre,
            document, telèfon o correu electrònic llegit d'una sessió, el rostre
            creat per Upload a face to a list, o l'UUID que has enviat (per
            exemple, un UUID de transacció o el `didit_internal_id` d'un
            usuari).
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Context addicional. Conté les claus que estableix Didit (llistades
            aquí) combinades amb qualsevol `metadata` que hagis enviat en crear
            l'entrada, retornades tal com s'han desat. `null` quan no n'hi ha
            cap.
          properties:
            reference_image_url:
              type: string
              description: >-
                Entrades facials: URL signada de curta durada, emesa de nou en
                cada crida; `null` per a una clau d'API amb un àmbit que no
                inclou `media: read`. Absent quan cap imatge pertany a
                l'entrada.
            front_image_url:
              type: string
              description: >-
                Entrades de document que contenen una imatge frontal del
                document: URL signat de curta durada, emès novament a cada
                crida; `null` per a una clau d'API amb abast limitat sense
                `media: read`.
            full_name:
              type: string
              description: >-
                Entrades de document obtingudes d'una sessió: nom complet del
                titular.
            issuing_state:
              type: string
              description: >-
                Entrades de document obtingudes d'una sessió: país emissor ISO
                3166-1 alfa-3.
            document_type:
              type: string
              description: >-
                Entrades de document obtingudes d'una sessió: codi de tipus de
                document, per exemple `P`, `ID` o `DL`.
            region:
              type: string
              description: >-
                Entrades de document obtingudes d'una sessió: estat o província
                emissor d'un document emès regionalment, buit quan no
                correspongui. No s'estableix mitjançant Add session items to the
                blocklist.
            document_number:
              type: string
              description: >-
                Entrades de document obtingudes d'una sessió: el número de
                document.
            face_image_source:
              type: string
              enum:
                - front_image_camera_front
                - back_image_camera_front
              description: >-
                Entrades facials obtingudes d'una selfie de captura de
                documents: quina selfie. No apareix per a cares de prova de
                vida.
            reference_node_id:
              type: string
              nullable: true
              description: >-
                Entrades facials obtingudes d'una selfie de captura de
                documents: el node de verificació d'identitat d'on prové la
                selfie.
            fingerprint_tier:
              type: string
              nullable: true
              enum:
                - persistent_id
                - composite_hash
                - legacy_fp
                - unknown
                - null
              description: >-
                Entrades de la petjada digital del dispositiu obtingudes d'una
                sessió: com es va derivar la petjada digital. `persistent_id`
                identifica un sol dispositiu; `composite_hash` i `legacy_fp` es
                poden compartir entre dispositius del mateix model.
            sandbox:
              type: boolean
              description: >-
                `true` en una entrada facial pujada en una aplicació sandbox;
                aquesta entrada no coincideix amb res.
            reference_type:
              type: string
              enum:
                - transaction
                - vendor_user
                - vendor_business
              description: >-
                Definit per tu: a què apunta `reference_object_uuid`, perquè la
                consola hi enllaci de tornada.
            reference_id:
              type: string
              description: 'Definit per tu: identificador del registre d''origen.'
        created_at:
          type: string
          format: date-time
          description: Quan es va afegir l'entrada.
  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.