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

# API Listes : listes de blocage et d'autorisation

> Gérez avec Didit les listes de blocage, d'autorisation et personnalisées pour le KYC, la fraude et le filtrage des transactions.



Prompt de l'API Lists
        Copier le prompt dans le presse-papiers



      
      

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



      
      

Coller dans

L'API Lists vous permet de gérer des listes typées pour votre application. Les listes de blocage du système sont créées automatiquement et consultées pendant la vérification et le filtrage des transactions. Vous pouvez aussi créer des listes d'autorisation et des listes personnalisées pour les conditions de workflow.## Concepts| Type | Description |
| - | - |
| **Liste de blocage** | Créée par le système, une par type d'entrée. Les éléments d'une liste de blocage entraînent un refus automatique pendant la vérification ou le filtrage des transactions. |
| **Liste d'autorisation** | Créée par l'utilisateur. Utilisée dans les conditions de workflow et pour supprimer les actions liées aux doublons et à la réutilisation pour les éléments correspondants fiables. |
| **Personnalisé** | Créée par l'utilisateur. Listes flexibles pour l'embranchement des workflows, les règles de surveillance ou l'examen manuel. |## Types d'entrées| Type d'entrée | Vérifié pendant | En cas de correspondance |
| - | - | - |
| `face` | Vérification du vivant | Session refusée |
| `document` | Vérification d'identité (OCR) | Session refusée |
| `phone` | Vérification du téléphone | Session refusée |
| `email` | Vérification de l'e-mail | Session refusée |
| `ip_address` | Analyse de l'appareil et de l'IP (prend en charge les plages CIDR) | Session refusée |
| `device_fingerprint` | Analyse de l'appareil et de l'IP | Session refusée |
| `wallet_address` | Filtrage des transactions | Transaction refusée |
| `bank_account` | Filtrage des transactions | Transaction refusée |
| `user` | Filtrage des transactions | Utilisateur bloqué |
| `business` | Filtrage des transactions | Entreprise bloquée |
| `country` | Conditions de workflow | Configurable |
| `key` | Usage personnalisé | Configurable |## Listes d'autorisationLes listes d'autorisation ne remplacent pas les listes de blocage ni les contrôles d'authenticité. Elles suppriment uniquement les actions de doublon et de réutilisation pour le même type d'entrée. Par exemple, un visage présent dans une liste d'autorisation de visages peut éviter le déclenchement de l'action `DUPLICATED_FACE`, une adresse IP présente dans une liste d'autorisation d'IP peut éviter le déclenchement de l'action `DUPLICATED_IP_ADDRESS`, et une empreinte d'appareil présente dans une liste d'autorisation d'appareils peut éviter le déclenchement de l'action `DUPLICATED_DEVICE_FINGERPRINT`. Didit enregistre tout de même un avertissement informatif de liste d'autorisation afin que vous puissiez vérifier pourquoi l'action de doublon n'a pas été exécutée.## Listes de blocage systèmeChaque application reçoit automatiquement 10 listes de blocage système (une par type d'entrée pris en charge) ainsi qu'une liste système **High Risk Countries**. Elles ne peuvent être ni supprimées ni renommées. Vous pouvez y ajouter des entrées via l'API ou depuis la console.## TraçabilitéChaque entrée d'une liste de blocage peut être reliée à l'entité source, afin que vous puissiez passer de la liste à l'enregistrement d'origine :- **Depuis une session** : transmettez `reference_session_id` lors de la [création d'une entrée](https://docs.didit.me/fr/management-api/lists/create-entry.md). Didit extrait automatiquement la valeur (visage, document, téléphone, e-mail, IP ou appareil), marque le modèle sous-jacent comme étant sur liste de blocage et relie l'entrée à la session. Didit lit l'enregistrement le plus récent de la session pour ce type ; pour inscrire une valeur provenant d'un enregistrement antérieur, ajoutez-la par `value` sans `reference_session_id`.
- **Depuis une transaction, un utilisateur ou une entreprise** : transmettez `reference_object_uuid` avec l'UUID de l'entité et incluez `metadata.reference_type` (`"transaction"`, `"vendor_user"` ou `"vendor_business"`) afin que la console puisse renvoyer vers l'enregistrement d'origine.## Endpoints> [card] [Lister toutes les listes](https://docs.didit.me/fr/management-api/lists/list.md)
>
> Récupérer toutes les listes d'une application.> [card] [Lister les entrées](https://docs.didit.me/fr/management-api/lists/list-entries.md)
>
> Récupérer les entrées d'une liste.> [card] [Créer une entrée](https://docs.didit.me/fr/management-api/lists/create-entry.md)
>
> Ajouter une valeur à une liste de blocage : par valeur, référence de session ou référence de transaction.> [card] [Supprimer une entrée](https://docs.didit.me/fr/management-api/lists/delete-entry.md)
>
> Supprimer une entrée et débloquer l'entité sous-jacente.> [card] [Importer un visage](https://docs.didit.me/fr/management-api/lists/upload-face.md)
>
> Importer directement une image de visage dans une liste de blocage de visages.


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