> ## 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 de bloqueio e de permissão > Gerir listas de bloqueio, permissão e personalizadas da Didit para KYC, fraude e triagem. Infraestrutura de identidade paga por chamada. Prompt da API de listas Copiar o prompt para a área de transferência \

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

\
Colar em A API de Listas permite-lhe gerir listas tipificadas para a sua aplicação. As listas de bloqueio do sistema são criadas automaticamente e verificadas durante a verificação e a triagem de transações. Também pode criar listas de permissão e listas personalizadas para condições do fluxo.## Conceitos| Tipo | Descrição | | - | - | | **Lista de bloqueio** | Criada pelo sistema, uma por tipo de entrada. Os itens de uma lista de bloqueio provocam a recusa automática durante a verificação ou a triagem de transações. | | **Lista de permissão** | Criada pelo utilizador. Usada em condições do fluxo e para suprimir ações de duplicação/reutilização em itens correspondentes considerados de confiança. | | **Personalizado** | Criada pelo utilizador. Listas flexíveis para ramificação de fluxos, regras de monitorização ou revisão manual. |## Tipos de entrada| Tipo de entrada | Verificado durante | Em caso de correspondência | | - | - | - | | `face` | Verificação de prova de vida | Sessão recusada | | `document` | Verificação de identidade (OCR) | Sessão recusada | | `phone` | Verificação de telefone | Sessão recusada | | `email` | Verificação de e-mail | Sessão recusada | | `ip_address` | Análise de dispositivo e IP (suporta intervalos CIDR) | Sessão recusada | | `device_fingerprint` | Análise de dispositivo e IP | Sessão recusada | | `wallet_address` | Triagem de transações | Transação recusada | | `bank_account` | Triagem de transações | Transação recusada | | `user` | Triagem de transações | Utilizador bloqueado | | `business` | Triagem de transações | Empresa bloqueada | | `country` | Condições do fluxo | Configurável | | `key` | Utilização personalizada | Configurável |## Listas de permissãoAs listas de permissão não se sobrepõem às listas de bloqueio nem às verificações de autenticidade. Apenas suprimem ações de duplicação/reutilização para o mesmo tipo de entrada. Por exemplo, uma face numa lista de permissão de faces pode ignorar a ação `DUPLICATED_FACE`, um IP numa lista de permissão de IP pode ignorar a ação `DUPLICATED_IP_ADDRESS`, e uma impressão digital de dispositivo numa lista de permissão de dispositivos pode ignorar a ação `DUPLICATED_DEVICE_FINGERPRINT`. A Didit regista, ainda assim, um aviso informativo da lista de permissão para que possa auditar o motivo pelo qual a ação de duplicação não foi executada.## Listas de bloqueio do sistemaCada aplicação recebe automaticamente 10 listas de bloqueio do sistema (uma por cada tipo de entrada suportado) e uma lista do sistema **High Risk Countries**. Estas listas não podem ser eliminadas nem renomeadas. Pode adicionar entradas através da API ou a partir da consola.## RastreabilidadeCada entrada de uma lista de bloqueio pode ser ligada à entidade de origem, para que possa navegar da lista até ao registo original:- **A partir de uma sessão**: passe `reference_session_id` ao [criar uma entrada](https://docs.didit.me/pt/management-api/lists/create-entry.md). A Didit extrai automaticamente o valor (face, documento, telefone, e-mail, IP ou dispositivo), marca o modelo subjacente como incluído numa lista de bloqueio e liga a entrada à sessão. A Didit lê o registo mais recente da sessão desse tipo; para adicionar à lista um valor de um registo anterior, adicione-o pelo `value` sem `reference_session_id`. - **A partir de uma transação, utilizador ou empresa**: passe `reference_object_uuid` com o UUID da entidade e inclua `metadata.reference_type` (`"transaction"`, `"vendor_user"` ou `"vendor_business"`) para que a consola possa ligar ao registo original.## Endpoints> [card] [Listar todas as listas](https://docs.didit.me/pt/management-api/lists/list.md) > > Obtenha todas as listas de uma aplicação.> [card] [Entradas da lista](https://docs.didit.me/pt/management-api/lists/list-entries.md) > > Obtenha as entradas de uma lista.> [card] [Criar entrada](https://docs.didit.me/pt/management-api/lists/create-entry.md) > > Adicione um valor a uma lista de bloqueio, por valor, referência de sessão ou referência de transação.> [card] [Eliminar entrada](https://docs.didit.me/pt/management-api/lists/delete-entry.md) > > Remova uma entrada e desbloqueie a entidade subjacente.> [card] [Carregar face](https://docs.didit.me/pt/management-api/lists/upload-face.md) > > Carregue uma imagem facial diretamente para uma lista de bloqueio de faces. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.