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

# Listeneinträge-API: Sperrlisten- und Allowlist-Einträge

> GET /v3/lists/{list_uuid}/entries/: Didit-Listeneinträge (Sperrliste, Allowlist, eigene Liste) paginiert abrufen, mit Suchfilter. Pro Aufruf.



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



      
      

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



      
      

Einfügen in

Ruft die Einträge einer Liste ab, neueste zuerst, optional mit Suche. `search` findet Teilübereinstimmungen im Wert oder Label eines Eintrags, unabhängig von Groß- und Kleinschreibung. `reference_session_id` schränkt die Ergebnisse auf die Einträge ein, die aus einer bestimmten Verifizierungssitzung stammen. Bei einer Gesichtsliste gibt `metadata.face_image_source` an, welches Gesicht der Sitzung der jeweilige Eintrag ist (`liveness`, wenn der Wert fehlt).Gesichts- und Dokumenteinträge enthalten Bild-URLs in `metadata`, die kurz nach dem Aufruf ablaufen. Rufen Sie die Einträge erneut ab, um frische URLs zu erhalten, statt sie zu speichern. Ein API-Schlüssel ohne **media: read** erhält für diese URLs `null`.


## OpenAPI

````yaml de/openapi-25.json GET /v3/lists/{list_uuid}/entries/
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}/entries/:
    get:
      tags:
        - Lists
      summary: Listeneinträge auflisten
      description: >-
        Gibt die aktuellen Einträge einer Liste zurück, die neuesten zuerst.
        `search` gleicht unabhängig von der Groß-/Kleinschreibung Teile des
        `value` oder `display_label` eines Eintrags ab, und
        `reference_session_id` grenzt die Ergebnisse auf Einträge aus einer
        Personenverifizierungssitzung ein. Bild-URLs in `metadata` sind
        kurzlebige signierte URLs, die bei jedem Aufruf neu ausgestellt werden;
        ein API-Schlüssel mit eingeschränktem Berechtigungsumfang ohne `media:
        read` erhält stattdessen `null`. Ein API-Schlüssel mit eingeschränktem
        Berechtigungsumfang benötigt `workflows: read`.
      operationId: list_list_entries
      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
        - name: search
          in: query
          required: false
          description: >-
            Text (ohne Berücksichtigung von Groß-/Kleinschreibung), den `value`
            oder `display_label` des Eintrags enthalten muss.
          schema:
            type: string
        - name: reference_session_id
          in: query
          required: false
          description: >-
            Nur die Einträge aus dieser Personen-Verifizierungssitzung, um
            beispielsweise zu sehen, welche ihrer Gesichter bereits aufgeführt
            sind.
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          description: >-
            Seitengröße. Standardmäßig 50. Ein Wert über 1000000 gibt `400`
            zurück; 0, ein negativer oder ein nicht-numerischer Wert fällt auf
            50 zurück.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
        - name: offset
          in: query
          required: false
          description: >-
            Nullbasierter Index des ersten zurückzugebenden Elements. Folgen Sie
            vorzugsweise `next`. Ein Wert über 1000000 gibt `400` zurück; ein
            negativer oder nicht-numerischer Wert fällt auf 0 zurück.
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
      responses:
        '200':
          description: Eine Seite mit Einträgen, neueste zuerst.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: Gesamtzahl der Einträge, die den Filtern entsprechen.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      Absolute URL der nächsten Seite oder `null` auf der
                      letzten Seite.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      Absolute URL der vorherigen Seite oder `null` auf der
                      ersten Seite.
                  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: Ein Abfrageparameter ist ungültig.
          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: >-
            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: List not found.
        '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/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: Ein Wert in einer 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: >-
            Eintrags-ID. Verwenden Sie sie als `entry_uuid` in „Listeneintrag
            löschen“.
        value:
          type: string
          description: >-
            Der gelistete Wert: eine Telefonnummer in E.164, eine
            E-Mail-Adresse, eine Dokumentennummer, eine IP-Adresse oder ein
            CIDR-Bereich, ein Geräte-Fingerprint, eine Wallet-Adresse, ein
            Bankkonto, ein Ländercode nach ISO 3166-1 Alpha-3, ein
            `vendor_data`, eine beliebige Zeichenfolge auf einer `key`-Liste
            oder die UUID des gespeicherten Gesichts auf einer Gesichtsliste.
            Von Ihnen gesendete Werte werden in Kleinbuchstaben gespeichert, mit
            Ausnahme von Telefonnummern und Ländercodes. Der Abgleich erfolgt
            ohne Berücksichtigung der Groß-/Kleinschreibung.
        display_label:
          type: string
          nullable: true
          maxLength: 512
          description: >-
            Lesbare Bezeichnung. Didit füllt sie für aus einer Sitzung
            übernommene Einträge aus (beispielsweise Name und Dokumentennummer
            des Inhabers), wenn Sie keine übermitteln.
        comment:
          type: string
          description: Freitext-Notiz. Leere Zeichenkette, wenn nicht festgelegt.
        added_by:
          type: string
          nullable: true
          description: >-
            Wer den Eintrag hinzugefügt hat: `api` (ein API-Schlüssel), die
            E-Mail-Adresse eines Benutzers der Konsole oder `console`, `system`
            oder `migration` (von Didit erstellte Einträge) oder `rule` (eine
            Transaktions- oder Überwachungsregel-Aktion).
        reference_session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Verifizierungssitzung, aus der der Eintrag übernommen wurde. `null`,
            wenn der Eintrag als Wert hinzugefügt wurde.
        reference_session_number:
          type: integer
          nullable: true
          description: >-
            Nummer dieser Sitzung innerhalb der Anwendung, wie in der Console
            angezeigt.
        reference_session_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - null
          description: >-
            `kyc` für eine Sitzung zur Personenverifizierung, `kyb` für eine
            Sitzung zur Unternehmensverifizierung, `null`, wenn keine Sitzung
            vorhanden ist.
        reference_object_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            Der Datensatz, für den der Eintrag steht: der aus einer Sitzung
            gelesene Gesichts-, Dokumenten-, Telefon- oder E-Mail-Datensatz, das
            über Ein Gesicht zu einer Liste hochladen erstellte Gesicht oder die
            von Ihnen gesendete UUID (z. B. eine Transaktions-UUID oder die
            `didit_internal_id` eines Benutzers).
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Zusätzlicher Kontext. Enthält die von Didit festgelegten Schlüssel
            (hier aufgeführt), zusammengeführt mit allen `metadata`, die Sie
            beim Erstellen des Eintrags gesendet haben, zurückgegeben wie
            gespeichert. `null`, wenn keine vorhanden sind.
          properties:
            reference_image_url:
              type: string
              description: >-
                Gesichtseinträge: kurzlebige signierte URL, die bei jedem Aufruf
                neu ausgestellt wird; `null` für einen
                berechtigungseingeschränkten API-Schlüssel ohne `media: read`.
                Fehlt, wenn kein Bild zum Eintrag gehört.
            front_image_url:
              type: string
              description: >-
                Dokumenteneinträge, die ein Bild der Dokumentenvorderseite
                enthalten: kurzlebige signierte URL, die bei jedem Aufruf neu
                ausgestellt wird; `null` für einen berechtigungseingeschränkten
                API-Schlüssel ohne `media: read`.
            full_name:
              type: string
              description: >-
                Aus einer Sitzung übernommene Dokumenteneinträge: vollständiger
                Name des Inhabers.
            issuing_state:
              type: string
              description: >-
                Aus einer Sitzung übernommene Dokumenteneinträge:
                Ausstellungsland nach ISO 3166-1 Alpha-3.
            document_type:
              type: string
              description: >-
                Aus einer Sitzung übernommene Dokumenteneinträge:
                Dokumenttyp-Code, zum Beispiel `P`, `ID` oder `DL`.
            region:
              type: string
              description: >-
                Aus einer Sitzung übernommene Dokumenteneinträge:
                Ausstellungs-Bundesstaat oder -Provinz eines regional
                ausgestellten Dokuments, leer, falls nicht zutreffend. Wird
                durch „Sitzungselemente zur Sperrliste hinzufügen“ nicht
                gesetzt.
            document_number:
              type: string
              description: >-
                Aus einer Sitzung übernommene Dokumenteneinträge: die
                Dokumentennummer.
            face_image_source:
              type: string
              enum:
                - front_image_camera_front
                - back_image_camera_front
              description: >-
                Aus einem Selfie bei der Dokumentenerfassung übernommene
                Gesichtseinträge: welches Selfie. Fehlt bei Liveness-Gesichtern.
            reference_node_id:
              type: string
              nullable: true
              description: >-
                Aus einem Selfie bei der Dokumentenerfassung übernommene
                Gesichtseinträge: der Ausweisverifizierungs-Knoten, aus dem das
                Selfie stammt.
            fingerprint_tier:
              type: string
              nullable: true
              enum:
                - persistent_id
                - composite_hash
                - legacy_fp
                - unknown
                - null
              description: >-
                Aus einer Sitzung erfasste Geräte-Fingerprint-Einträge: wie der
                Fingerprint abgeleitet wurde. `persistent_id` identifiziert ein
                einzelnes Gerät; `composite_hash` und `legacy_fp` können von
                Geräten desselben Modells geteilt werden.
            sandbox:
              type: boolean
              description: >-
                `true` bei einem Gesichtseintrag, der in einer Sandbox-Anwendung
                hochgeladen wurde; ein solcher Eintrag stimmt mit nichts
                überein.
            reference_type:
              type: string
              enum:
                - transaction
                - vendor_user
                - vendor_business
              description: >-
                Von Ihnen festgelegt: Worauf `reference_object_uuid` verweist,
                damit die Console darauf zurückverlinkt.
            reference_id:
              type: string
              description: 'Von Ihnen festgelegt: Kennung des Quelldatensatzes.'
        created_at:
          type: string
          format: date-time
          description: Wann der Eintrag hinzugefügt 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.