> ## 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 de entradas de lista: lista de bloqueo y permitidos

> GET /v3/lists/{list_uuid}/entries/: obtén entradas paginadas de una lista de bloqueo, de permitidos o personalizada de Didit con búsqueda. Pago por llamada.



Prompt de la API de entradas de lista
        Copiar el prompt al portapapeles



      
      

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



      
      

Pegar en

Obtén las entradas de una lista, de la más reciente a la más antigua, con búsqueda opcional. `search` busca coincidencias con parte del valor o de la etiqueta de una entrada sin distinguir mayúsculas de minúsculas; `reference_session_id` limita los resultados a las entradas tomadas de una sesión de verificación concreta. En una lista de rostros, `metadata.face_image_source` indica a cuál de los rostros de la sesión corresponde cada entrada (`liveness` cuando no aparece).Las entradas de rostros y de documentos incluyen en `metadata` URL de imágenes que expiran poco después de la llamada. Vuelve a obtener las entradas para conseguir URL nuevas en lugar de almacenarlas. Una clave de API sin **media: read** recibe `null` para esas URL.


## OpenAPI

````yaml es/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ón de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/lists/{list_uuid}/entries/:
    get:
      tags:
        - Lists
      summary: Listar entradas de una lista
      description: >-
        Devuelve las entradas actuales de una lista, de más reciente a más
        antigua. `search` busca coincidencias con una parte del `value` o del
        `display_label` de una entrada sin distinguir mayúsculas de minúsculas,
        y `reference_session_id` limita los resultados a las entradas tomadas de
        una sesión de verificación de persona. Las URL de imágenes en `metadata`
        son URL firmadas de corta duración que se emiten de nuevo en cada
        llamada; una clave de API con alcance limitado sin `media: read` recibe
        `null` en su lugar. Una clave de API con alcance limitado necesita
        `workflows: read`.
      operationId: list_list_entries
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID de la lista, tal como lo devuelven Listar listas o Crear una
            lista.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
        - name: search
          in: query
          required: false
          description: >-
            Texto, sin distinguir mayúsculas y minúsculas, que debe contener el
            `value` o el `display_label` de la entrada.
          schema:
            type: string
        - name: reference_session_id
          in: query
          required: false
          description: >-
            Solo las entradas tomadas de esta sesión de verificación de persona,
            por ejemplo para ver cuáles de sus rostros ya están en una lista.
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          description: >-
            Tamaño de página. El valor predeterminado es 50. Un valor superior a
            1000000 devuelve `400`; cero, un valor negativo o un valor no
            numérico hacen que se use 50.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
        - name: offset
          in: query
          required: false
          description: >-
            Índice, empezando en cero, del primer elemento que se devuelve. Es
            preferible seguir `next`. Un valor superior a 1000000 devuelve
            `400`; un valor negativo o no numérico se toma como 0.
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
      responses:
        '200':
          description: Una página de entradas, de la más reciente a la más antigua.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: Número total de entradas que coinciden con los filtros.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta de la página siguiente, o `null` en la última
                      página.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta de la página anterior, o `null` en 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ámetro de consulta no es válido.
          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 clave de API con alcance limitado ha expirado. Los demás fallos
            de autenticación devuelven `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falta el encabezado `x-api-key` (una clave incorrecta, revocada o
            expirada recibe `401`), o una clave de API con alcance limitado no
            tiene `workflows: read` o se usa desde una dirección IP que no está
            en su lista de permitidas.
          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 existe ninguna lista con este UUID en la aplicación de la clave
            de API, o se eliminó.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: List not found.
        '429':
          description: >-
            Se superó el límite de lectura compartido de 600 solicitudes por
            minuto por clave de API. Respeta `Retry-After` antes 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 de una lista.
      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 la entrada. Úsalo como `entry_uuid` en Eliminar una
            entrada de lista.
        value:
          type: string
          description: >-
            El valor incluido en la lista: un número de teléfono en formato
            E.164, una dirección de correo electrónico, un número de documento,
            una dirección IP o un rango CIDR, una huella de dispositivo, una
            dirección de wallet, una cuenta bancaria, un código de país ISO
            3166-1 alfa-3, un `vendor_data`, cualquier cadena en una lista
            `key`, o el UUID del rostro almacenado en una lista de rostros. Los
            valores que envías se almacenan en minúsculas, excepto los números
            de teléfono y los códigos de país. La coincidencia no distingue
            entre mayúsculas y minúsculas.
        display_label:
          type: string
          nullable: true
          maxLength: 512
          description: >-
            Etiqueta legible. Didit la completa en las entradas tomadas de una
            sesión (por ejemplo, el nombre del titular y el número de documento)
            cuando no envías ninguna.
        comment:
          type: string
          description: Nota en texto libre. Cadena vacía cuando no está definida.
        added_by:
          type: string
          nullable: true
          description: >-
            Quién añadió la entrada: `api` (una clave de API), el correo
            electrónico de un usuario de la consola o `console`, `system` o
            `migration` (entradas creadas por Didit), o `rule` (una acción de
            una regla de transacciones o de monitorización).
        reference_session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Sesión de verificación de la que se tomó la entrada. `null` cuando
            la entrada se añadió por valor.
        reference_session_number:
          type: integer
          nullable: true
          description: >-
            Número de esa sesión dentro de la aplicación, tal como se muestra en
            la consola.
        reference_session_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - null
          description: >-
            `kyc` para una sesión de verificación de una persona, `kyb` para una
            sesión de verificación de una empresa, `null` cuando no hay sesión.
        reference_object_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            El registro que representa la entrada: el registro de rostro,
            documento, teléfono o correo electrónico leído de una sesión, el
            rostro creado con Subir un rostro a una lista, o el UUID que
            enviaste (por ejemplo, el UUID de una transacción o el
            `didit_internal_id` de un usuario).
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Contexto adicional. Contiene las claves que establece Didit
            (enumeradas aquí) combinadas con cualquier `metadata` que enviaste
            al crear la entrada, devueltas tal como se almacenaron. `null`
            cuando no hay ninguna.
          properties:
            reference_image_url:
              type: string
              description: >-
                Entradas de rostro: URL firmada de corta duración, que se emite
                de nuevo en cada llamada; `null` para una clave de API con
                alcance limitado sin `media: read`. No aparece cuando ninguna
                imagen pertenece a la entrada.
            front_image_url:
              type: string
              description: >-
                Entradas de documento que incluyen una imagen del anverso del
                documento: URL firmada de corta duración, que se emite de nuevo
                en cada llamada; `null` para una clave de API con alcance
                limitado sin `media: read`.
            full_name:
              type: string
              description: >-
                Entradas de documento tomadas de una sesión: nombre completo del
                titular.
            issuing_state:
              type: string
              description: >-
                Entradas de documento tomadas de una sesión: país emisor en
                formato ISO 3166-1 alfa-3.
            document_type:
              type: string
              description: >-
                Entradas de documento tomadas de una sesión: código del tipo de
                documento, por ejemplo `P`, `ID` o `DL`.
            region:
              type: string
              description: >-
                Entradas de documento tomadas de una sesión: estado o provincia
                emisora de un documento de emisión regional; vacío cuando no
                aplica. No lo establece Añadir elementos de la sesión a la lista
                de bloqueo.
            document_number:
              type: string
              description: >-
                Entradas de documento tomadas de una sesión: el número de
                documento.
            face_image_source:
              type: string
              enum:
                - front_image_camera_front
                - back_image_camera_front
              description: >-
                Entradas de rostro tomadas de una selfie de captura de
                documento: qué selfie es. No aparece en los rostros de prueba de
                vida.
            reference_node_id:
              type: string
              nullable: true
              description: >-
                Entradas de rostro tomadas de una selfie de captura de
                documento: el nodo de verificación de identidad del que procede
                la selfie.
            fingerprint_tier:
              type: string
              nullable: true
              enum:
                - persistent_id
                - composite_hash
                - legacy_fp
                - unknown
                - null
              description: >-
                Entradas de huella digital del dispositivo tomadas de una
                sesión: indican cómo se derivó la huella. `persistent_id`
                identifica un único dispositivo; `composite_hash` y `legacy_fp`
                pueden ser compartidos por dispositivos del mismo modelo.
            sandbox:
              type: boolean
              description: >-
                `true` en una entrada facial subida en una aplicación de
                sandbox; esa entrada no coincide con nada.
            reference_type:
              type: string
              enum:
                - transaction
                - vendor_user
                - vendor_business
              description: >-
                Lo defines tú: a qué apunta `reference_object_uuid`, para que la
                consola enlace de vuelta a él.
            reference_id:
              type: string
              description: 'Lo defines tú: identificador del registro de origen.'
        created_at:
          type: string
          format: date-time
          description: Cuándo se añadió la entrada.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, que encontrarás en Developers -> API
        keys en la Business Console. La clave principal tiene acceso completo.
        Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
        escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
        a una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, se revocó o expiró; 403 significa que no se
        envió ninguna clave, que la clave no tiene acceso a este recurso o
        acción, o que la solicitud provino de una dirección fuera de su lista de
        IP; 404 en una ruta de sesión significa que la sesión está fuera de los
        flujos o estados de la clave. Una clave sin acceso a contenido
        multimedia recibe las URL de imágenes, videos y PDF como null, y una
        clave sin permiso de escritura en sesiones recibe los enlaces y tokens
        de sesión como null. Consulta https://docs.didit.me/console/api-keys.

````

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