> ## 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 para listar listas: listas de bloqueio e de permissão > GET /v3/lists/ da Didit: obtenha listas de bloqueio, de permissão e personalizadas. Filtre por tipo de lista ou entrada. Pague por uso, sem contratos. Prompt da API para listar listas Copiar o prompt para a área de transferência \

\`Retrieve every blocklist, allowlist, and custom list in my Didit application through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: read.

Goal:
\- Get a paginated list of all lists for my application so I can find a specific list's uuid, filter by type, or render a picker.

Behavior:
\- Returns the application's active lists, newest first by default. Deleted lists never appear.
\- Includes the system lists Didit provisions (is_system: true): one blocklist per entry type, the "High Risk Countries" custom list, and any system allowlist.
\- Paginated with limit (default 50) and offset. Follow next until it is null.

Query parameters (all optional):
\- list_type: "blocklist" | "allowlist" | "custom".
\- entry_type: face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, country, user, business, key.
\- ordering: created_at or -created_at (default).
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Example call:
curl -X GET "https://verification.didit.me/v3/lists/?list_type=blocklist" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].uuid: list id; use it as list_uuid in the list and entry calls.
\- results[].is_system: true for the lists Didit provisions. System lists cannot be renamed, edited or deleted, but you can add and remove their entries.
\- results[].entry_count, last_entry_added_at: computed over the list's current entries; useful for dashboards.

Failure modes:
\- 400: an unknown list_type or entry_type value, or limit/offset above 1000000.
\- 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: read.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\
Colar em Recupere uma lista paginada de todas as listas ativas da sua aplicação: as listas do sistema que a Didit fornece (uma lista de bloqueio por tipo de entrada, a lista **High Risk Countries** e qualquer lista de permissões do sistema) e as listas de permissões e listas personalizadas que você criou. Filtre por `list_type` ou `entry_type` e leia os valores de uma lista com [Listar entradas](https://docs.didit.me/pt-br/management-api/lists/list-entries.md).Consulte [Listas](https://docs.didit.me/pt-br/management-api/lists/overview.md) para saber o que cada tipo de lista faz durante a verificação e a triagem de transações. ## OpenAPI ````yaml pt-br/openapi-25.json GET /v3/lists/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/lists/: get: tags: - Lists summary: Listar listas description: >- Retorna as listas da aplicação, da mais recente para a mais antiga: as listas do sistema que a Didit provisiona (uma lista de bloqueio por tipo de entrada, a lista personalizada **High Risk Countries** e qualquer lista de permissões do sistema) e as listas de permissões e listas personalizadas que você criou. Filtre com `list_type` e `entry_type`; listas excluídas nunca aparecem. Os resultados são paginados com `limit` e `offset`. Uma chave de API com escopo precisa de `workflows: read`. Consulte [Listas](https://docs.didit.me/pt-br/management-api/lists/overview) para saber o que cada tipo de lista faz. operationId: list_lists parameters: - name: list_type in: query required: false description: Somente listas deste tipo. schema: type: string enum: - blocklist - allowlist - custom - name: entry_type in: query required: false description: Somente listas deste tipo de entrada. schema: type: string enum: - face - document - phone - email - ip_address - device_fingerprint - wallet_address - bank_account - country - user - business - key - name: ordering in: query required: false description: >- Ordem de classificação: `-created_at` (mais recentes primeiro, o padrão) ou `created_at` (mais antigos primeiro). schema: type: string enum: - '-created_at' - created_at default: '-created_at' - name: limit in: query required: false description: >- Tamanho da página. O padrão é 50. Um valor acima de 1000000 retorna `400`; zero, um valor negativo ou não numérico volta para 50. schema: type: integer default: 50 minimum: 1 maximum: 1000000 - name: offset in: query required: false description: >- Índice, a partir de zero, do primeiro item a retornar. Prefira seguir `next`. Um valor acima de 1000000 retorna `400`; um valor negativo ou não numérico passa a ser 0. schema: type: integer maximum: 1000000 minimum: 0 default: 0 responses: '200': description: Uma página de listas. content: application/json: schema: type: object required: - count - next - previous - results properties: count: type: integer minimum: 0 description: Número total de listas que correspondem aos filtros. next: type: string format: uri nullable: true description: >- URL absoluta da próxima página, ou `null` na última página. previous: type: string format: uri nullable: true description: >- URL absoluta da página anterior, ou `null` na primeira página. results: type: array items: $ref: '#/components/schemas/ComplianceList' examples: Lists: value: count: 2 next: null previous: null results: - uuid: 22222222-3333-4444-5555-666666666666 name: Trusted office IPs description: Office egress ranges list_type: allowlist entry_type: ip_address is_system: false entry_count: 3 last_entry_added_at: '2026-10-02T08:15:27.501334Z' created_at: '2026-09-30T13:20:45.889120Z' updated_at: '2026-09-30T13:20:45.889120Z' - uuid: 11111111-2222-3333-4444-555555555555 name: Face Blocklist description: >- Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined. list_type: blocklist entry_type: face is_system: true entry_count: 12 last_entry_added_at: '2026-10-09T16:42:03.118204Z' created_at: '2026-01-14T10:02:11.402917Z' updated_at: '2026-01-14T10:02:11.402917Z' '400': description: Um parâmetro de consulta é inválido. content: application/json: examples: Unknown list type: value: list_type: - '"denylist" is not a valid choice.' Unsupported ordering: value: ordering: - '"name" is not a valid choice.' Limit too large: value: - limit must not exceed 1000000. '401': description: >- A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: read` ou é usada a partir de um endereço IP fora da sua lista de permissões. content: application/json: examples: Missing or invalid API key: value: detail: You do not have permission to perform this action. Scoped key without workflows access: value: detail: This API key has no read access to workflows. '429': description: >- O limite compartilhado de leitura de 600 requisições por minuto por chave de API foi excedido. Respeite `Retry-After` antes de tentar novamente. content: application/json: examples: Rate limited: value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/lists/?list_type=blocklist' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.lists.list(): print(item) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.lists.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.ListAutoPaging(ctx, didit.ListsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.lists().list()) { System.out.println(item); } - lang: php label: PHP source: |- lists->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.lists.list.auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.Lists.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: ComplianceList: type: object description: >- Uma lista de bloqueio, lista de permissões ou lista personalizada de uma aplicação. required: - uuid - name - description - list_type - entry_type - is_system - entry_count - last_entry_added_at - created_at - updated_at properties: uuid: type: string format: uuid description: >- Identificador da lista. Use-o como `list_uuid` nos endpoints de listas e de entradas, e como valor de uma condição de regra de fluxo ou de transação com `value_type: "list"`. name: type: string maxLength: 255 description: Nome da lista, único entre as listas da aplicação. description: type: string description: Descrição em texto livre. String vazia quando não definida. list_type: type: string enum: - blocklist - allowlist - custom description: >- `blocklist`: uma correspondência recusa a sessão ou a transação (somente listas do sistema, uma por tipo de entrada). `allowlist`: os itens correspondentes são considerados confiáveis; por exemplo, uma allowlist de rostos ignora a ação de rosto duplicado; nunca prevalece sobre uma correspondência na lista de bloqueio. `custom`: usada em condições de regras de fluxo e de transação (`value_type: "list"`). entry_type: type: string enum: - face - document - phone - email - ip_address - device_fingerprint - wallet_address - bank_account - country - user - business - key description: >- O que a lista contém: `face`, `document` (número do documento), `phone`, `email`, `ip_address` (endereço IP ou intervalo CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` ou `business` (seu `vendor_data`), ou `key` (qualquer string). Define como os valores das entradas são validados e comparados. is_system: type: boolean description: >- `true` para as listas que a Didit provisiona: uma lista de bloqueio por tipo de entrada (`face`, `document`, `phone`, `email`, `ip_address`, `device_fingerprint`, `wallet_address`, `bank_account`, `user`, `business`), a lista personalizada **High Risk Countries** e as listas de permissão do sistema. As listas do sistema não podem ser renomeadas, editadas nem excluídas; você pode adicionar e excluir as entradas delas. entry_count: type: integer minimum: 0 description: Número de entradas atualmente na lista. last_entry_added_at: type: string format: date-time nullable: true description: >- Quando a entrada atual mais recente foi adicionada. `null` para uma lista vazia. created_at: type: string format: date-time description: Quando a lista foi criada. updated_at: type: string format: date-time description: Quando a lista foi atualizada pela última vez. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.