> ## 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 listas: listas de bloqueo y listas de permitidos

> Gestiona listas de bloqueo, listas de permitidos y listas personalizadas de Didit para KYC, fraude y control de transacciones. Pago por llamada.



Prompt de la API de listas
        Copiar el prompt al portapapeles



      
      

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



      
      

Pegar en

La API de listas te permite gestionar listas con tipos para tu aplicación. Las listas de bloqueo del sistema se crean automáticamente y se comprueban durante la verificación y el análisis de transacciones. También puedes crear listas de permitidos y listas personalizadas para las condiciones de los flujos.## Conceptos| Tipo | Descripción |
| - | - |
| **Lista de bloqueo** | Creada por el sistema, una por tipo de entrada. Los elementos de una lista de bloqueo provocan el rechazo automático durante la verificación o el análisis de transacciones. |
| **Lista de permitidos** | Creada por el usuario. Se usa en las condiciones de los flujos y para suprimir las acciones duplicadas o de reutilización para elementos coincidentes de confianza. |
| **Personalizado** | Creada por el usuario. Listas flexibles para la ramificación de flujos, reglas de monitorización o revisión manual. |## Tipos de entrada| Tipo de entrada | Se comprueba durante | Si hay coincidencia |
| - | - | - |
| `face` | Verificación de vitalidad | Sesión rechazada |
| `document` | Verificación de identidad (OCR) | Sesión rechazada |
| `phone` | Verificación de teléfono | Sesión rechazada |
| `email` | Verificación de correo electrónico | Sesión rechazada |
| `ip_address` | Análisis de dispositivo e IP (admite rangos CIDR) | Sesión rechazada |
| `device_fingerprint` | Análisis de dispositivo e IP | Sesión rechazada |
| `wallet_address` | Análisis de transacciones | Transacción rechazada |
| `bank_account` | Análisis de transacciones | Transacción rechazada |
| `user` | Análisis de transacciones | Usuario bloqueado |
| `business` | Análisis de transacciones | Empresa bloqueada |
| `country` | Condiciones de los flujos | Configurable |
| `key` | Uso personalizado | Configurable |## Listas permitidasLas listas permitidas no anulan las listas de bloqueo ni las comprobaciones de autenticidad. Solo suprimen las acciones de duplicado/reutilización para el mismo tipo de entrada. Por ejemplo, un rostro incluido en una lista permitida de rostros puede omitir la acción `DUPLICATED_FACE`, una IP incluida en una lista permitida de IP puede omitir la acción `DUPLICATED_IP_ADDRESS` y una huella de dispositivo incluida en una lista permitida de dispositivos puede omitir la acción `DUPLICATED_DEVICE_FINGERPRINT`. Didit sigue registrando una advertencia informativa de lista permitida para que puedas auditar por qué no se ejecutó la acción de duplicado.## Listas de bloqueo del sistemaCada aplicación recibe automáticamente 10 listas de bloqueo del sistema (una por cada tipo de entrada admitido) y una lista del sistema **High Risk Countries**. No se pueden eliminar ni renombrar. Puedes añadirles entradas mediante la API o desde la consola.## TrazabilidadCada entrada de una lista de bloqueo puede vincularse a su entidad de origen para que puedas navegar desde la lista hasta el registro original:- **Desde una sesión**: envía `reference_session_id` al [crear una entrada](https://docs.didit.me/es/management-api/lists/create-entry.md). Didit extrae automáticamente el valor (rostro, documento, teléfono, correo electrónico, IP o dispositivo), marca el modelo subyacente como incluido en la lista de bloqueo y vincula la entrada a la sesión. Didit lee el registro más reciente de ese tipo en la sesión; para incluir en la lista un valor de un registro anterior, añádelo mediante `value` sin `reference_session_id`.
- **Desde una transacción, un usuario o una empresa**: envía `reference_object_uuid` con el UUID de la entidad e incluye `metadata.reference_type` (`"transaction"`, `"vendor_user"` o `"vendor_business"`) para que la consola pueda vincular la entrada al registro original.## Endpoints> [card] [Listar todas las listas](https://docs.didit.me/es/management-api/lists/list.md)
>
> Obtén todas las listas de una aplicación.> [card] [Listar entradas](https://docs.didit.me/es/management-api/lists/list-entries.md)
>
> Obtén las entradas de una lista.> [card] [Crear entrada](https://docs.didit.me/es/management-api/lists/create-entry.md)
>
> Añade un valor a una lista de bloqueo: por valor, por referencia de sesión o por referencia de transacción.> [card] [Eliminar entrada](https://docs.didit.me/es/management-api/lists/delete-entry.md)
>
> Elimina una entrada y desbloquea la entidad subyacente.> [card] [Subir rostro](https://docs.didit.me/es/management-api/lists/upload-face.md)
>
> Sube una imagen de un rostro directamente a una lista de bloqueo de rostros.


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