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

# Sperrlisten-Einträge auflisten: Blocklist API

> GET /v3/blocklist/ listet Gesichter, Dokumente, Telefonnummern und E-Mails von der Didit-Sperrliste auf, neueste zuerst, in einem Feed.



Prompt für die API zum Auflisten gesperrter Einträge
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`List the blocklisted faces, documents, phone numbers and email addresses of my Didit verification sessions through the Management API.

Endpoint:
GET https://verification.didit.me/v3/blocklist/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: read.

Goal:
\- Get one paginated feed of every session record that is currently blocklisted, to build a "Blocked" screen or audit what my team has blocked.

Behavior:
\- Items are sorted by blocklisted_at, newest first. Items of deleted sessions are not included.
\- Each item has a type ("face", "document", "phone" or "email") and the session it belongs to (session_id, session_number). Fields that do not apply to the type are null.
\- The feed covers records blocklisted from a session: with POST /v3/blocklist/add/, from the console, or with a list entry created from reference_session_id. It does not include values added to a list by hand, uploaded faces, faces taken from a document-capture selfie, or IP address, device fingerprint, wallet, bank account, user and business entries. Read those with GET /v3/lists/{list_uuid}/entries/ on the matching system blocklist.
\- face_image and front_image are short-lived signed URLs, issued again on every call; a scoped key without media: read gets null instead.

Query parameters (all optional):
\- item_type: "face" | "document" | "phone" | "email". When omitted, every type is returned.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Example call:
curl -X GET "https://verification.didit.me/v3/blocklist/?item_type=document" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].type, session_id, session_number, blocklisted_at.
\- face items: face_image.
\- document items: document_type (for example "P" passport, "ID" national ID, "DL" driver's license), document_number, front_image.
\- phone items: phone_number (E.164), country_code (ISO 3166-1 alpha-2).
\- email items: email.

Failure modes:
\- 400: an unknown item_type, 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.
\- 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

Listen Sie die Gesichter, Ausweisdokumente, Telefonnummern und E-Mail-Adressen Ihrer Verifizierungssitzungen auf, die derzeit auf der Sperrliste stehen, neueste zuerst. Jeder Eintrag verweist auf die Sitzung, aus der er stammt, sodass Sie sie in der Konsole öffnen oder deren Entscheidung abrufen können.Dieser Feed zeigt, was **aus einer Sitzung heraus** auf die Sperrliste gesetzt wurde: mit [Zur Sperrliste hinzufügen](https://docs.didit.me/de/management-api/blocklist/add.md), über die Konsole oder mit einem [Listeneintrag](https://docs.didit.me/de/management-api/lists/create-entry.md), der aus `reference_session_id` erstellt wurde. Manuell in eine Liste eingegebene Werte, [hochgeladene Gesichter](https://docs.didit.me/de/management-api/lists/upload-face.md), Gesichter aus einem Selfie der Dokumentenerfassung sowie die übrigen Eintragstypen (IP-Adresse, Geräte-Fingerabdruck, Wallet, Bankkonto, Benutzer, Unternehmen) sind nur in den Systemsperrlisten enthalten. Lesen Sie sie mit [Listeneinträgen](https://docs.didit.me/de/management-api/lists/list-entries.md).Informationen dazu, wie das Sperren in der Konsole funktioniert, finden Sie unter [Benutzer auf die Sperrliste setzen](https://docs.didit.me/de/console/blocklist-users.md).


## OpenAPI

````yaml de/openapi-25.json GET /v3/blocklist/
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/blocklist/:
    get:
      tags:
        - Blocklist
      summary: Einträge auf der Sperrliste auflisten
      description: >-
        Gibt einen paginierten Feed der Gesichter, Ausweisdokumente,
        Telefonnummern und E-Mail-Adressen aus den Verifizierungssitzungen der
        Anwendung zurück, die derzeit auf der Sperrliste stehen, sortiert nach
        `blocklisted_at` in absteigender Reihenfolge; filtern Sie mit
        `item_type`. Elemente gelöschter Sitzungen sind nicht enthalten. Der
        Feed umfasst Datensätze, die aus einer Sitzung auf die Sperrliste
        gesetzt wurden (mit [Sitzungselemente zur Sperrliste
        hinzufügen](https://docs.didit.me/de/management-api/blocklist/add), über
        die Konsole oder durch einen aus einer Sitzung erstellten
        Listeneintrag); manuell zu einer Liste hinzugefügte Werte, hochgeladene
        Gesichter, Gesichter aus einem Selfie der Dokumentenerfassung und die
        anderen Eintragstypen werden mit [Listeneinträge
        auflisten](https://docs.didit.me/de/management-api/lists/list-entries)
        abgerufen. `face_image` und `front_image` sind kurzlebige signierte
        URLs, und ein API-Schlüssel mit eingeschränktem Berechtigungsumfang ohne
        `media: read` erhält `null`. Ein API-Schlüssel mit eingeschränktem
        Berechtigungsumfang benötigt `workflows: read`.
      operationId: list_blocklist_items
      parameters:
        - name: item_type
          in: query
          required: false
          description: >-
            Nur Elemente dieses Typs. Wenn weggelassen, werden alle Typen
            zurückgegeben.
          schema:
            type: string
            enum:
              - face
              - document
              - phone
              - email
        - 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 auf der Sperrliste, neueste zuerst.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: >-
                      Gesamtzahl der Einträge auf der Sperrliste, 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/BlocklistedItem'
              examples:
                Mixed feed:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - type: document
                        session_id: 33333333-4444-5555-6666-777777777777
                        session_number: 1042
                        blocklisted_at: '2026-10-12T10:06:12.701553Z'
                        face_image: null
                        document_type: ID
                        document_number: X1234567
                        front_image: >-
                          https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47
                        phone_number: null
                        country_code: null
                        email: null
                      - type: phone
                        session_id: 77777777-8888-9999-0000-111111111111
                        session_number: 1017
                        blocklisted_at: '2026-10-08T15:31:09.400127Z'
                        face_image: null
                        document_type: null
                        document_number: null
                        front_image: null
                        phone_number: '+14155552671'
                        country_code: US
                        email: null
        '400':
          description: Ein Abfrageparameter ist ungültig.
          content:
            application/json:
              examples:
                Unknown item type:
                  value:
                    item_type:
                      - '"wallet" is not a valid choice.'
                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.
        '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/blocklist/?item_type=document' \
              -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.blocklist.list():
                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.blocklist.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\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.blocklist().list()) {
                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->blocklist->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.blocklist.list.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.Blocklist.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    BlocklistedItem:
      type: object
      description: >-
        Ein Gesicht, Ausweisdokument, eine Telefonnummer oder E-Mail-Adresse auf
        der Sperrliste einer Verifizierungssitzung. Felder, die für den `type`
        des Eintrags nicht zutreffen, sind `null`.
      required:
        - type
        - session_id
        - session_number
        - blocklisted_at
        - face_image
        - document_type
        - document_number
        - front_image
        - phone_number
        - country_code
        - email
      properties:
        type:
          type: string
          enum:
            - face
            - document
            - phone
            - email
          description: Was auf die Sperrliste gesetzt wurde.
        session_id:
          type: string
          format: uuid
          description: Verifizierungssitzung, zu der das Element gehört.
        session_number:
          type: integer
          nullable: true
          description: >-
            Nummer dieser Sitzung innerhalb der Anwendung, wie in der Console
            angezeigt.
        blocklisted_at:
          type: string
          format: date-time
          description: Wann das Element zuletzt auf die Sperrliste gesetzt wurde.
        face_image:
          type: string
          nullable: true
          description: >-
            Gesichtselemente: kurzlebige signierte URL, die bei jedem Aufruf neu
            ausgestellt wird; `null` für einen berechtigungseingeschränkten
            API-Schlüssel ohne `media: read`. Ebenfalls `null`, wenn kein
            Referenzbild gespeichert ist.
        document_type:
          type: string
          nullable: true
          description: >-
            Dokumentenelemente: Dokumenttyp-Code, zum Beispiel `P` (Reisepass),
            `ID` (Personalausweis), `DL` (Führerschein) oder `RP`
            (Aufenthaltstitel).
        document_number:
          type: string
          nullable: true
          description: >-
            Dokumentenelemente: die Dokumentennummer oder die persönliche
            Nummer, falls das Dokument keine Nummer aufweist.
        front_image:
          type: string
          nullable: true
          description: >-
            Dokumentenelemente: Vorderseitenbild des Dokuments, kurzlebige
            signierte URL, die bei jedem Aufruf neu ausgestellt wird; `null` für
            einen berechtigungseingeschränkten API-Schlüssel ohne `media: read`.
        phone_number:
          type: string
          nullable: true
          description: 'Telefonelemente: die Telefonnummer im E.164-Format.'
        country_code:
          type: string
          nullable: true
          description: 'Telefonelemente: ISO 3166-1 alpha-2-Land der Nummer.'
        email:
          type: string
          nullable: true
          description: 'E-Mail-Elemente: die E-Mail-Adresse.'
  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.