> ## 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 des entrées de liste : blocage et autorisation

> GET /v3/lists/{list_uuid}/entries/ : récupérez les entrées paginées d'une liste Didit (blocage, autorisation, personnalisée). Facturation à l'appel.



Prompt de l'API des entrées de liste
        Copier le prompt dans le presse-papiers



      
      

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



      
      

Coller dans

Récupérez les entrées d'une liste, de la plus récente à la plus ancienne, avec une recherche facultative. `search` retrouve une partie de la valeur ou du libellé d'une entrée, sans tenir compte de la casse ; `reference_session_id` limite les résultats aux entrées issues d'une seule session de vérification. Sur une liste de visages, `metadata.face_image_source` indique à quel visage de la session chaque entrée correspond (`liveness` si le champ est absent).Les entrées faciales et de documents contiennent dans `metadata` des URL d'images qui expirent peu après l'appel. Récupérez à nouveau les entrées pour obtenir de nouvelles URL plutôt que de les stocker. Une clé API sans **media: read** reçoit `null` pour ces URL.


## OpenAPI

````yaml fr/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 vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/lists/{list_uuid}/entries/:
    get:
      tags:
        - Lists
      summary: Lister les entrées de liste
      description: >-
        Renvoie les entrées actuelles d'une liste, les plus récentes en premier.
        `search` fait correspondre une partie de la valeur `value` ou de
        `display_label` d'une entrée sans tenir compte de la casse, et
        `reference_session_id` restreint les résultats aux entrées issues d'une
        session de vérification de personne. Les URL d'images dans `metadata`
        sont des URL signées à courte durée de vie générées à nouveau à chaque
        appel ; une clé API restreinte sans `media: read` reçoit `null` à leur
        place. Une clé API restreinte nécessite `workflows: read`.
      operationId: list_list_entries
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID de la liste, tel que renvoyé par Lister les listes ou Créer une
            liste.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
        - name: search
          in: query
          required: false
          description: >-
            Texte insensible à la casse que la `value` ou le `display_label` de
            l'entrée doit contenir.
          schema:
            type: string
        - name: reference_session_id
          in: query
          required: false
          description: >-
            Uniquement les entrées issues de cette session de vérification d'une
            personne, par exemple pour voir lesquels de ses visages sont déjà
            répertoriés.
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          description: "Taille de page. Vaut 50 par défaut. Une valeur supérieure à 1000000 renvoie `400`\_; une valeur égale à zéro, négative ou non numérique repasse par défaut à 50."
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
        - name: offset
          in: query
          required: false
          description: >-
            Indice de départ (base zéro) du premier élément à retourner.
            Privilégiez l'utilisation de `next`. Une valeur supérieure à 1000000
            retourne `400` ; une valeur négative ou non numérique revient par
            défaut à 0.
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
      responses:
        '200':
          description: Une page d'entrées, les plus récentes en premier.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: Nombre total d'entrées correspondant aux filtres.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absolue de la page suivante, ou `null` sur la dernière
                      page.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absolue de la page précédente, ou `null` sur la
                      première page.
                  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 paramètre de requête est invalide.
          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 clé API restreinte a expiré. Les autres échecs d'authentification
            renvoient `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            L'en-tête `x-api-key` est manquant (une clé incorrecte, révoquée ou
            expirée renvoie `401`), ou une clé API restreinte n'a pas
            l'autorisation `workflows: read` ou est utilisée depuis une adresse
            IP hors de sa liste d'autorisation.
          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: >-
            Aucune liste avec cet UUID n'existe dans l'application de la clé
            API, ou elle a été supprimée.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: List not found.
        '429':
          description: >-
            La limite de lecture partagée de 600 requêtes par minute et par clé
            API a été dépassée. Respectez l'en-tête `Retry-After` avant de
            réessayer.
          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: Une valeur dans une liste.
      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: >-
            Identifiant d'entrée. Utilisez-le comme `entry_uuid` dans Supprimer
            une entrée de liste.
        value:
          type: string
          description: "La valeur répertoriée\_: un numéro de téléphone au format E.164, une adresse e-mail, un numéro de document, une adresse IP ou une plage CIDR, une empreinte d'appareil, une adresse, un compte bancaire, un code pays ISO 3166-1 alpha-3, une `vendor_data`, toute chaîne de caractères sur une liste de type `key`, ou l'UUID du visage enregistré sur une liste de visages. Les valeurs que vous envoyez sont stockées en minuscules, à l'exception des numéros de téléphone et des codes pays. La recherche de correspondance est insensible à la casse."
        display_label:
          type: string
          nullable: true
          maxLength: 512
          description: >-
            Libellé lisible par l'humain. Didit le renseigne pour les entrées
            issues d'une session (par exemple le nom du titulaire et le numéro
            de document) lorsque vous n'en transmettez aucun.
        comment:
          type: string
          description: Note en texte libre. Chaîne vide lorsqu'elle n'est pas définie.
        added_by:
          type: string
          nullable: true
          description: >-
            Qui a ajouté l'entrée : `api` (une clé API), l'adresse e-mail d'un
            utilisateur de la console ou `console`, `system` ou `migration`
            (entrées créées par Didit), ou `rule` (une action de règle de
            transaction ou de surveillance).
        reference_session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Session de vérification dont provient l'entrée. `null` lorsque
            l'entrée a été ajoutée par valeur.
        reference_session_number:
          type: integer
          nullable: true
          description: >-
            Numéro de cette session propre à l'application, tel qu'affiché dans
            la console.
        reference_session_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - null
          description: >-
            `kyc` pour une session de vérification de personne, `kyb` pour une
            session de vérification d'entreprise, `null` lorsqu'il n'y a pas de
            session.
        reference_object_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            L'enregistrement que l'entrée représente : l'enregistrement de
            visage, de document, de téléphone ou d'e-mail lu à partir d'une
            session, le visage créé par Charger un visage dans une liste, ou
            l'UUID que vous avez envoyé (par exemple un UUID de transaction ou
            le `didit_internal_id` d'un utilisateur).
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Contexte supplémentaire. Contient les clés définies par Didit
            (listées ici) fusionnées avec les `metadata` que vous avez envoyées
            lors de la création de l'entrée, renvoyées telles quelles. `null`
            lorsqu'il n'y en a pas.
          properties:
            reference_image_url:
              type: string
              description: >-
                Entrées faciales : URL signée à courte durée de vie, réémise à
                chaque appel ; `null` pour une clé API restreinte sans `media:
                read`. Absent lorsqu'aucune image n'est associée à l'entrée.
            front_image_url:
              type: string
              description: >-
                Entrées de documents comportant une image du recto du document :
                URL signée de courte durée, réémise à chaque appel ; `null` pour
                une clé API restreinte sans `media: read`.
            full_name:
              type: string
              description: >-
                Entrées de documents issues d'une session : nom complet du
                titulaire.
            issuing_state:
              type: string
              description: >-
                Entrées de documents issues d'une session : pays de délivrance
                ISO 3166-1 alpha-3.
            document_type:
              type: string
              description: >-
                Entrées de documents issues d'une session : code du type de
                document, par exemple `P`, `ID` ou `DL`.
            region:
              type: string
              description: >-
                Entrées de documents issues d'une session : État ou province de
                délivrance pour un document émis au niveau régional, vide si non
                applicable. Non défini par l'ajout d'éléments de session à la
                liste de blocage.
            document_number:
              type: string
              description: 'Entrées de documents issues d''une session : numéro du document.'
            face_image_source:
              type: string
              enum:
                - front_image_camera_front
                - back_image_camera_front
              description: >-
                Entrées faciales issues d'un selfie de capture de document :
                identifiant du selfie. Absent pour les visages de détection du
                vivant.
            reference_node_id:
              type: string
              nullable: true
              description: >-
                Entrées faciales issues d'un selfie de capture de document : le
                nœud de Vérification d'identité dont provient le selfie.
            fingerprint_tier:
              type: string
              nullable: true
              enum:
                - persistent_id
                - composite_hash
                - legacy_fp
                - unknown
                - null
              description: "Entrées d'empreinte d'appareil provenant d'une session\_: mode de dérivation de l'empreinte. `persistent_id` identifie un appareil\_; `composite_hash` et `legacy_fp` peuvent être partagés par des appareils du même modèle."
            sandbox:
              type: boolean
              description: >-
                `true` pour une entrée faciale téléversée dans une application
                sandbox ; une telle entrée ne correspond à aucun élément.
            reference_type:
              type: string
              enum:
                - transaction
                - vendor_user
                - vendor_business
              description: >-
                Défini par vous : élément vers lequel pointe
                `reference_object_uuid`, afin que la console puisse créer un
                lien vers celui-ci.
            reference_id:
              type: string
              description: 'Défini par vous : identifiant de l''enregistrement source.'
        created_at:
          type: string
          format: date-time
          description: Date et heure d'ajout de l'entrée.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clé API de votre application, issue de Développeurs -> Clés API dans
        la Business Console. La clé principale dispose d'un accès complet. Une
        clé nommée peut être restreinte : aucun, lecture ou écriture par
        ressource, limitée à certains workflows ou aux sessions approuvées, à
        une liste d'adresses IP et à une date d'expiration. 401 signifie que la
        clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
        été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
        que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
        une route de session signifie que la session est hors des workflows ou
        des statuts de la clé. Une clé sans accès aux médias reçoit les URL
        d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
        aux sessions reçoit les liens et tokens de session à null. Voir
        https://docs.didit.me/console/api-keys.

````

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