> ## 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 de llistes de bloqueig i de permesos

> Gestiona les llistes de bloqueig, de permesos i personalitzades de Didit per a KYC, frau i cribratge. Pagament per crida.



Prompt de l'API de llistes
        Copia el prompt al porta-retalls



      
      

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



      
      

Enganxa a

L'API de llistes et permet gestionar llistes tipificades per a la teva aplicació. Les llistes de bloqueig del sistema es creen automàticament i es comproven durant la verificació i el cribratge de transaccions. També pots crear llistes d'autorització i llistes personalitzades per a les condicions del flux de treball.## Conceptes| Tipus | Descripció |
| - | - |
| **Llista de bloqueig** | Creada pel sistema, una per tipus d'entrada. Els elements d'una llista de bloqueig provoquen un rebuig automàtic durant la verificació o el cribratge de transaccions. |
| **Llista d'autorització** | Creada per l'usuari. S'utilitza en les condicions del flux de treball i per suprimir les accions de duplicat o reutilització per a elements coincidents considerats de confiança. |
| **Personalitzat** | Creada per l'usuari. Llistes flexibles per a la bifurcació del flux de treball, les regles de monitoratge o la revisió manual. |## Tipus d'entrada| Tipus d'entrada | Es comprova durant | En cas de coincidència |
| - | - | - |
| `face` | Verificació de prova de vida | Sessió rebutjada |
| `document` | Verificació d'identitat (OCR) | Sessió rebutjada |
| `phone` | Verificació de telèfon | Sessió rebutjada |
| `email` | Verificació de correu electrònic | Sessió rebutjada |
| `ip_address` | Anàlisi de dispositiu i IP (admet rangs CIDR) | Sessió rebutjada |
| `device_fingerprint` | Anàlisi de dispositiu i IP | Sessió rebutjada |
| `wallet_address` | Cribratge de transaccions | Transacció rebutjada |
| `bank_account` | Cribratge de transaccions | Transacció rebutjada |
| `user` | Cribratge de transaccions | Usuari bloquejat |
| `business` | Cribratge de transaccions | Empresa bloquejada |
| `country` | Condicions del flux de treball | Configurable |
| `key` | Ús personalitzat | Configurable |## Llistes d'autoritzacióLes llistes d'autorització no substitueixen les llistes de bloqueig ni les comprovacions d'autenticitat. Només suprimeixen les accions de duplicat o reutilització per al mateix tipus d'entrada. Per exemple, una cara d'una llista d'autorització facial pot evitar l'acció `DUPLICATED_FACE`, una IP d'una llista d'autorització d'IP pot evitar l'acció `DUPLICATED_IP_ADDRESS`, i una empremta digital de dispositiu d'una llista d'autorització de dispositius pot evitar l'acció `DUPLICATED_DEVICE_FINGERPRINT`. Didit registra igualment una advertència informativa de la llista d'autorització perquè puguis auditar per què no s'ha executat l'acció de duplicat.## Llistes de bloqueig del sistemaCada aplicació obté automàticament 10 llistes de bloqueig del sistema (una per tipus d'entrada compatible) i una llista del sistema **Països d'alt risc**. Aquestes llistes no es poden eliminar ni canviar de nom. Pots afegir-hi entrades mitjançant l'API o des de la consola.## TraçabilitatCada entrada d'una llista de bloqueig es pot vincular a l'entitat d'origen, de manera que pots anar de la llista al registre original:- **Des d'una sessió**: passa `reference_session_id` en [crear una entrada](https://docs.didit.me/ca/management-api/lists/create-entry.md). Didit extreu automàticament el valor (cara, document, telèfon, correu electrònic, IP o dispositiu), marca el model subjacent com a inclòs a la llista de bloqueig i enllaça l'entrada amb la sessió. Didit llegeix el registre més recent de la sessió per a aquest tipus; per llistar un valor d'un registre anterior, afegeix-lo amb `value` sense `reference_session_id`.
- **Des d'una transacció, un usuari o una empresa**: passa `reference_object_uuid` amb l'UUID de l'entitat i inclou `metadata.reference_type` (`"transaction"`, `"vendor_user"` o `"vendor_business"`) perquè la consola pugui enllaçar amb el registre original.## Endpoints> [card] [Llista totes les llistes](https://docs.didit.me/ca/management-api/lists/list.md)
>
> Recupera totes les llistes d'una aplicació.> [card] [Llista les entrades](https://docs.didit.me/ca/management-api/lists/list-entries.md)
>
> Recupera les entrades d'una llista.> [card] [Crea una entrada](https://docs.didit.me/ca/management-api/lists/create-entry.md)
>
> Afegeix un valor a una llista de bloqueig mitjançant el valor, una referència de sessió o una referència de transacció.> [card] [Elimina una entrada](https://docs.didit.me/ca/management-api/lists/delete-entry.md)
>
> Elimina una entrada i desbloqueja l'entitat subjacent.> [card] [Puja una cara](https://docs.didit.me/ca/management-api/lists/upload-face.md)
>
> Puja directament una imatge facial a una llista de bloqueig facial.


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