> ## 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-API: Sperrlisten & Allowlists

> Verwalten Sie Didit-Sperrlisten, Allowlists und eigene Listen für KYC, Betrugs- und Transaktionsscreening. Abrechnung pro Aufruf.



Prompt für die Lists API
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Manage Didit blocklists, allowlists, and custom lists through the Management API.

Base path:
https://verification.didit.me/v3/lists/

Authentication:
Use the x-api-key header with my Didit API key on every call.

Concepts:
\- Blocklist — system-created, one per entry type. Items in a blocklist cause automatic decline during verification or transaction screening. Cannot be deleted or renamed.
\- Allowlist: created by you, or by Didit as a system allowlist that cannot be renamed or deleted. Used in workflow conditions and to suppress duplicate/reuse actions for trusted matching items.
\- Custom — user-created. Flexible lists for workflow branching, monitoring rules, or manual review.

Supported entry_type values:
face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business, country, key.

Endpoints I should know:
\- GET /v3/lists/ — list all lists (filter by list_type, entry_type).
\- POST /v3/lists/ — create allowlist or custom list (cannot create blocklists).
\- GET /v3/lists/{list_uuid}/ — get one list.
\- PATCH /v3/lists/{list_uuid}/ — rename or update description (system lists immutable).
\- DELETE /v3/lists/{list_uuid}/ — delete allowlist/custom only. Returns 204.
\- GET /v3/lists/{list_uuid}/entries/ — paginated entries; supports search query.
\- POST /v3/lists/{list_uuid}/entries/ — add an entry by value, by reference_session_id, or by reference_object_uuid + metadata.reference_type ("transaction" | "vendor_user" | "vendor_business").
\- POST /v3/lists/{list_uuid}/entries/face-upload/: upload a base64 face image to a face blocklist or face allowlist; Didit extracts the biometric.
\- DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/ — remove an entry. For system blocklists this auto-unblocks the underlying entity.

Value validation (Create entry):
\- email — valid email address.
\- phone — valid international phone number (auto-normalized to E.164).
\- ip_address — IP or CIDR range (e.g. 10.0.0.0/8).
\- device_fingerprint: at least 8 characters among letters, digits, -, _, : and . (a blocklist refuses a fingerprint that several distinct devices have reported).
\- country — ISO 3166-1 alpha-3 (alpha-2 is accepted and converted).
\- Other types — any non-empty string. Values are case-insensitive and normalized on storage.

Traceability:
\- Pass reference_session_id when blocklisting from a verification session: Didit auto-extracts the right value (face/document/phone/email/IP/device), marks the underlying model as blocklisted, and links the entry back to the session. Didit reads the session's most recent record of that type; to list a value from an earlier record, add it by value without reference_session_id.
\- Pass reference_object_uuid plus metadata.reference_type ("transaction" | "vendor_user" | "vendor_business") when blocklisting from a transaction or vendor user/business so the console can link back to the source.

Common failure modes:
\- 400: value fails the entry_type validator or is already in the list, list_type is wrong for the operation (e.g. POST face-upload on a non-face list), reference_session_id has no data of the requested type, a system list is modified or deleted, or a list name is already used in this application (on create or rename).
\- 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 access.
\- 404: list or entry not found in this application (a list of another application also returns 404).

Side effects:
\- Adding to a system blocklist immediately blocks future matches at verification/screening time.
\- Deleting an entry from a system blocklist unblocks the matching entity.
\- Lists are referenced by workflow status_rules (value_type: "list") for runtime list checks.

For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`

\</pre>



      
      

Einfügen in

Mit der Lists API verwalten Sie typisierte Listen für Ihre Anwendung. System-Sperrlisten werden automatisch erstellt und bei der Verifizierung sowie beim Transaktions-Screening geprüft. Sie können außerdem Zulassungslisten und benutzerdefinierte Listen für Workflow-Bedingungen erstellen.## Konzepte| Typ | Beschreibung |
| - | - |
| **Sperrliste** | Vom System erstellt, eine pro Eintragstyp. Einträge in einer Sperrliste führen bei der Verifizierung oder beim Transaktions-Screening automatisch zur Ablehnung. |
| **Zulassungsliste** | Vom Benutzer erstellt. Wird in Workflow-Bedingungen verwendet und unterdrückt Duplikat- und Wiederverwendungsaktionen für vertrauenswürdige übereinstimmende Einträge. |
| **Benutzerdefiniert** | Vom Benutzer erstellt. Flexible Listen für Workflow-Verzweigungen, Überwachungsregeln oder manuelle Prüfung. |## Eintragstypen| Eintragstyp | Geprüft bei | Bei Treffer |
| - | - | - |
| `face` | Liveness-Verifizierung | Sitzung abgelehnt |
| `document` | Ausweisverifizierung (OCR) | Sitzung abgelehnt |
| `phone` | Telefonverifizierung | Sitzung abgelehnt |
| `email` | E-Mail-Verifizierung | Sitzung abgelehnt |
| `ip_address` | Geräte- und IP-Analyse (unterstützt CIDR-Bereiche) | Sitzung abgelehnt |
| `device_fingerprint` | Geräte- und IP-Analyse | Sitzung abgelehnt |
| `wallet_address` | Transaktions-Screening | Transaktion abgelehnt |
| `bank_account` | Transaktions-Screening | Transaktion abgelehnt |
| `user` | Transaktions-Screening | Benutzer gesperrt |
| `business` | Transaktions-Screening | Unternehmen gesperrt |
| `country` | Workflow-Bedingungen | Konfigurierbar |
| `key` | Benutzerdefinierte Nutzung | Konfigurierbar |## ZulassungslistenZulassungslisten heben Sperrlisten oder Echtheitsprüfungen nicht auf. Sie unterdrücken nur Duplikat- und Wiederverwendungsaktionen für denselben Eintragstyp. Ein Gesicht in einer Gesichts-Zulassungsliste kann zum Beispiel die Aktion `DUPLICATED_FACE` überspringen, eine IP-Adresse in einer IP-Zulassungsliste kann die Aktion `DUPLICATED_IP_ADDRESS` überspringen, und ein Geräte-Fingerprint in einer Geräte-Zulassungsliste kann die Aktion `DUPLICATED_DEVICE_FINGERPRINT` überspringen. Didit protokolliert trotzdem eine informative Warnung zur Zulassungsliste, damit Sie nachvollziehen können, warum die Duplikataktion nicht ausgeführt wurde.## System-SperrlistenJede Anwendung erhält automatisch 10 System-Sperrlisten (eine pro unterstütztem Eintragstyp) und eine System-Liste **High Risk Countries**. Diese können weder gelöscht noch umbenannt werden. Sie können über die API oder über die Konsole Einträge hinzufügen.## RückverfolgbarkeitJeder Eintrag in einer Sperrliste kann mit seiner Quelle verknüpft werden, sodass Sie von der Liste zum ursprünglichen Datensatz navigieren können:- **Aus einer Sitzung**: Übergeben Sie `reference_session_id` beim [Erstellen eines Eintrags](https://docs.didit.me/de/management-api/lists/create-entry.md). Didit extrahiert den Wert (Gesicht, Dokument, Telefon, E-Mail, IP oder Gerät) automatisch, markiert das zugrunde liegende Modell als gesperrt und verknüpft den Eintrag wieder mit der Sitzung. Didit liest den neuesten Datensatz dieses Typs in der Sitzung. Um einen Wert aus einem früheren Datensatz aufzunehmen, fügen Sie ihn über `value` ohne `reference_session_id` hinzu.
- **Aus einer Transaktion, einem Benutzer oder einem Unternehmen**: Übergeben Sie `reference_object_uuid` mit der UUID der Entität und fügen Sie `metadata.reference_type` hinzu (`"transaction"`, `"vendor_user"` oder `"vendor_business"`), damit die Konsole zum ursprünglichen Datensatz zurückverknüpfen kann.## Endpoints> [card] [Alle Listen abrufen](https://docs.didit.me/de/management-api/lists/list.md)
>
> Alle Listen einer Anwendung abrufen.> [card] [Einträge auflisten](https://docs.didit.me/de/management-api/lists/list-entries.md)
>
> Einträge einer Liste abrufen.> [card] [Eintrag erstellen](https://docs.didit.me/de/management-api/lists/create-entry.md)
>
> Einen Wert zu einer Sperrliste hinzufügen: per Wert, Sitzungsreferenz oder Transaktionsreferenz.> [card] [Eintrag löschen](https://docs.didit.me/de/management-api/lists/delete-entry.md)
>
> Einen Eintrag entfernen und die zugrunde liegende Entität entsperren.> [card] [Gesicht hochladen](https://docs.didit.me/de/management-api/lists/upload-face.md)
>
> Ein Gesichtsbild direkt in eine Gesichts-Sperrliste hochladen.


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