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

# Récupérer une liste de conformité : API Didit

> GET /v3/lists/{list_uuid}/ : Didit renvoie les détails d'une liste de blocage, d'autorisation ou personnalisée, nombre d'entrées et métadonnées.



Prompt de l'API pour obtenir une liste
        Copier le prompt dans le presse-papiers



      
      

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



      
      

Coller dans

Récupérez les détails d'une liste, y compris son nombre d'entrées et la date d'ajout de son entrée la plus récente. Une liste appartenant à une autre application, ou une liste supprimée, renvoie `404`.Pour lire les valeurs de la liste, utilisez [Entrées de liste](https://docs.didit.me/fr/management-api/lists/list-entries.md).


## OpenAPI

````yaml fr/openapi-25.json GET /v3/lists/{list_uuid}/
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}/:
    get:
      tags:
        - Lists
      summary: Obtenir une liste
      description: "Renvoie une liste de l'application avec son nombre d'entrées et la date à laquelle sa dernière entrée a été ajoutée. Une liste appartenant à une autre application, ou ayant été supprimée, renvoie `404`. Cela renvoie uniquement la liste\_: lisez ses valeurs avec [Lister les entrées de la liste](https://docs.didit.me/fr/management-api/lists/list-entries). Une clé API restreinte nécessite `workflows: read`."
      operationId: get_list
      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
      responses:
        '200':
          description: La liste.
          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 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: No List matches the given query.
        '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/'
            \
              -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: >-
        Une liste de blocage, une liste d'autorisation ou une liste
        personnalisée d'une application.
      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: >-
            Identifiant de liste. Utilisez-le comme `list_uuid` dans les
            endpoints de liste et d'entrée, et comme valeur d'une condition de
            règle de workflow ou de transaction avec `value_type: "list"`.
        name:
          type: string
          maxLength: 255
          description: Nom de la liste, unique parmi les listes de l'application.
        description:
          type: string
          description: >-
            Description en texte libre. Chaîne vide lorsqu'elle n'est pas
            définie.
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist` : une correspondance refuse la session ou la transaction
            (listes système uniquement, une par type d'entrée). `allowlist` :
            les éléments correspondants sont considérés comme fiables, par
            exemple une liste d'autorisation de visages ignore l'action de
            visage dupliqué ; ne prévaut jamais sur une correspondance de liste
            de blocage. `custom` : utilisé dans les conditions de règles de
            transaction et de workflow (`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: "Ce que contient la liste\_: `face`, `document` (numéro de document), `phone`, `email`, `ip_address` (adresse ou plage CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` ou `business` (vos `vendor_data`), ou `key` (toute chaîne). Cela détermine la manière dont les valeurs des entrées sont validées et mises en correspondance."
        is_system:
          type: boolean
          description: >-
            `true` pour les listes configurées par Didit : une liste de blocage
            par type d'entrée (`face`, `document`, `phone`, `email`,
            `ip_address`, `device_fingerprint`, `wallet_address`,
            `bank_account`, `user`, `business`), la liste personnalisée **High
            Risk Countries** et les listes d'autorisation du système. Les listes
            système ne peuvent être ni renommées, ni modifiées, ni supprimées ;
            vous pouvez ajouter et supprimer leurs entrées.
        entry_count:
          type: integer
          minimum: 0
          description: Nombre d'entrées actuellement dans la liste.
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Moment où l'entrée actuelle la plus récente a été ajoutée. `null`
            pour une liste vide.
        created_at:
          type: string
          format: date-time
          description: Moment où la liste a été créée.
        updated_at:
          type: string
          format: date-time
          description: Moment où la liste a été mise à jour pour la dernière fois.
  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.