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

# Compliance-Liste abrufen: Get List API

> GET /v3/lists/{list_uuid}/: Ruft Details einer Didit-Sperrliste, Allowlist oder benutzerdefinierten Liste ab, inkl. Anzahl der Einträge.



Prompt für die Get-List-API
        Prompt in die Zwischenablage kopieren



      
      

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



      
      

Einfügen in

Rufen Sie die Details einer Liste ab, einschließlich der Anzahl ihrer Einträge und des Zeitpunkts, zu dem der neueste Eintrag hinzugefügt wurde. Eine Liste einer anderen Anwendung oder eine gelöschte Liste gibt `404` zurück.Um die Werte in der Liste zu lesen, verwenden Sie [Listeneinträge](https://docs.didit.me/de/management-api/lists/list-entries.md).


## OpenAPI

````yaml de/openapi-25.json GET /v3/lists/{list_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/lists/{list_uuid}/:
    get:
      tags:
        - Lists
      summary: Liste abrufen
      description: >-
        Gibt eine Liste der Anwendung mit ihrer Eintragsanzahl und dem Zeitpunkt
        zurück, zu dem ihr neuester Eintrag hinzugefügt wurde. Eine Liste einer
        anderen Anwendung oder eine gelöschte Liste gibt `404` zurück. Dies gibt
        nur die Liste zurück: Lesen Sie deren Werte mit [Listeneinträge
        auflisten](https://docs.didit.me/de/management-api/lists/list-entries).
        Ein API-Schlüssel mit Scopes benötigt `workflows: read`.
      operationId: get_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID der Liste, wie sie von „Listen auflisten“ oder „Liste
            erstellen“ zurückgegeben wird.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      responses:
        '200':
          description: Die 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: >-
            Der API-Schlüssel mit eingeschränktem Geltungsbereich ist
            abgelaufen. Andere Authentifizierungsfehler geben `403` zurück.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Der `x-api-key`-Header fehlt (ein falscher, widerrufener oder
            abgelaufener Schlüssel erhält `401`), oder ein
            berechtigungseingeschränkter API-Schlüssel verfügt nicht über
            `workflows: read` oder wird von einer IP-Adresse außerhalb seiner
            Zulassungsliste verwendet.
          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: >-
            In der Anwendung des API-Schlüssels existiert keine Liste mit dieser
            UUID, oder sie wurde gelöscht.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '429':
          description: >-
            Das geteilte Leselimit von 600 Anfragen pro Minute pro API-Schlüssel
            wurde überschritten. Beachten Sie `Retry-After`, bevor Sie es erneut
            versuchen.
          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: >-
        Eine Sperrliste, Positivliste oder benutzerdefinierte Liste einer
        Anwendung.
      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: >-
            Listen-Identifikator. Verwenden Sie ihn als `list_uuid` in den
            Listen- und Eintrag-Endpoints sowie als Wert einer Workflow- oder
            Transaktionsregel-Bedingung mit `value_type: "list"`.
        name:
          type: string
          maxLength: 255
          description: Listenname, eindeutig unter den Listen der Anwendung.
        description:
          type: string
          description: Freitext-Beschreibung. Leere Zeichenkette, wenn nicht festgelegt.
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist`: Eine Übereinstimmung lehnt die Sitzung oder Transaktion
            ab (nur Systemlisten, eine pro Eintragstyp). `allowlist`:
            Übereinstimmende Elemente gelten als vertrauenswürdig,
            beispielsweise überspringt eine Gesichts-Allowlist die Aktion für
            doppelte Gesichter; überschreibt niemals eine
            Sperrlisten-Übereinstimmung. `custom`: Wird in Workflow- und
            Transaktionsregel-Bedingungen verwendet (`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: >-
            Was die Liste enthält: `face`, `document` (Dokumentennummer),
            `phone`, `email`, `ip_address` (Adresse oder CIDR-Bereich),
            `device_fingerprint`, `wallet_address`, `bank_account`, `country`
            (ISO 3166-1 Alpha-3), `user` oder `business` (Ihre `vendor_data`)
            oder `key` (eine beliebige Zeichenkette). Damit wird bestimmt, wie
            Eintragswerte validiert und abgeglichen werden.
        is_system:
          type: boolean
          description: >-
            `true` für die von Didit bereitgestellten Listen: eine Sperrliste
            pro Eintragstyp (`face`, `document`, `phone`, `email`, `ip_address`,
            `device_fingerprint`, `wallet_address`, `bank_account`, `user`,
            `business`), die benutzerdefinierte Liste **High Risk Countries**
            und System-Positivlisten. Systemlisten können weder umbenannt noch
            bearbeitet oder gelöscht werden; Sie können deren Einträge
            hinzufügen und löschen.
        entry_count:
          type: integer
          minimum: 0
          description: Anzahl der Einträge, die sich derzeit in der Liste befinden.
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Wann der neueste aktuelle Eintrag hinzugefügt wurde. `null` bei
            einer leeren Liste.
        created_at:
          type: string
          format: date-time
          description: Wann die Liste erstellt wurde.
        updated_at:
          type: string
          format: date-time
          description: Wann die Liste zuletzt aktualisiert wurde.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
        der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
        Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
        oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
        Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
        auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
        oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
        der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
        die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
        einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
        oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
        erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
        null. Siehe https://docs.didit.me/console/api-keys.

````

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