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

# Blocklist e allowlist API: Lists API di Didit

> Gestisci con Didit blocklist, allowlist e liste personalizzate per KYC, frode e screening. Infrastruttura di identità a consumo.



Lists API Prompt
        Copia il prompt negli appunti



      
      

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



      
      

Incolla in

L'API Lists ti permette di gestire liste tipizzate per la tua applicazione. Le blocklist di sistema vengono create automaticamente e controllate durante la verifica e lo screening delle transazioni. Puoi anche creare allowlist e liste personalizzate da usare nelle condizioni del workflow.## Concetti| Tipo | Descrizione |
| - | - |
| **Blocklist** | Creata dal sistema, una per tipo di voce. Gli elementi presenti in una blocklist causano un rifiuto automatico durante la verifica o lo screening delle transazioni. |
| **Allowlist** | Creata dall'utente. Usata nelle condizioni del workflow e per sopprimere le azioni di duplicato/riutilizzo per gli elementi corrispondenti attendibili. |
| **Personalizzata** | Creata dall'utente. Liste flessibili per la diramazione del workflow, le regole di monitoraggio o la revisione manuale. |## Tipi di voce| Tipo di voce | Controllato durante | In caso di corrispondenza |
| - | - | - |
| `face` | Verifica della vitalità | Sessione rifiutata |
| `document` | Verifica dell'identità (OCR) | Sessione rifiutata |
| `phone` | Verifica telefonica | Sessione rifiutata |
| `email` | Verifica email | Sessione rifiutata |
| `ip_address` | Analisi dispositivo e IP (supporta intervalli CIDR) | Sessione rifiutata |
| `device_fingerprint` | Analisi dispositivo e IP | Sessione rifiutata |
| `wallet_address` | Screening delle transazioni | Transazione rifiutata |
| `bank_account` | Screening delle transazioni | Transazione rifiutata |
| `user` | Screening delle transazioni | Utente bloccato |
| `business` | Screening delle transazioni | Azienda bloccata |
| `country` | Condizioni del workflow | Configurabile |
| `key` | Uso personalizzato | Configurabile |## AllowlistLe allowlist non sovrascrivono le blocklist né i controlli di autenticità. Sopprimono soltanto le azioni di duplicato/riutilizzo per lo stesso tipo di voce. Ad esempio, un volto presente in un'allowlist di volti può saltare l'azione `DUPLICATED_FACE`, un IP presente in un'allowlist di IP può saltare l'azione `DUPLICATED_IP_ADDRESS` e un device fingerprint presente in un'allowlist di dispositivi può saltare l'azione `DUPLICATED_DEVICE_FINGERPRINT`. Didit registra comunque un avviso informativo dell'allowlist, così puoi verificare il motivo per cui l'azione di duplicato non è stata eseguita.## Blocklist di sistemaOgni applicazione riceve automaticamente 10 blocklist di sistema (una per tipo di voce supportato) e una lista di sistema **High Risk Countries**. Non possono essere eliminate né rinominate. Puoi aggiungere voci tramite l'API o dalla console.## TracciabilitàOgni voce di una blocklist può essere collegata alla sua entità di origine, così puoi passare dalla lista al record originale:- **Da una sessione**: passa `reference_session_id` quando [crei una voce](https://docs.didit.me/it/management-api/lists/create-entry.md). Didit estrae automaticamente il valore (volto, documento, telefono, email, IP o dispositivo), contrassegna il modello sottostante come presente in blocklist e collega la voce alla sessione. Didit legge il record più recente della sessione di quel tipo; per inserire un valore da un record precedente, aggiungilo tramite `value` senza `reference_session_id`.
- **Da una transazione, un utente o un'azienda**: passa `reference_object_uuid` con l'UUID dell'entità e includi `metadata.reference_type` (`"transaction"`, `"vendor_user"` o `"vendor_business"`), così la console può collegarsi al record originale.## Endpoint> [card] [Elenca tutte le liste](https://docs.didit.me/it/management-api/lists/list.md)
>
> Recupera tutte le liste di un'applicazione.> [card] [Voci della lista](https://docs.didit.me/it/management-api/lists/list-entries.md)
>
> Recupera le voci di una lista.> [card] [Crea voce](https://docs.didit.me/it/management-api/lists/create-entry.md)
>
> Aggiungi un valore a una blocklist, tramite valore, riferimento di sessione o riferimento di transazione.> [card] [Elimina voce](https://docs.didit.me/it/management-api/lists/delete-entry.md)
>
> Rimuovi una voce e sblocca l'entità sottostante.> [card] [Carica volto](https://docs.didit.me/it/management-api/lists/upload-face.md)
>
> Carica direttamente un'immagine del volto in una blocklist di volti.


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