> ## 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. # Listar itens da lista de bloqueio via API > GET /v3/blocklist/: lista faces, documentos, telefones e e-mails bloqueados nas sessões Didit, do mais recente para o mais antigo. Prompt da API para listar itens na lista de bloqueio Copiar o prompt para a área de transferência \

\`List the blocklisted faces, documents, phone numbers and email addresses of my Didit verification sessions through the Management API.

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

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

Goal:
\- Get one paginated feed of every session record that is currently blocklisted, to build a "Blocked" screen or audit what my team has blocked.

Behavior:
\- Items are sorted by blocklisted_at, newest first. Items of deleted sessions are not included.
\- Each item has a type ("face", "document", "phone" or "email") and the session it belongs to (session_id, session_number). Fields that do not apply to the type are null.
\- The feed covers records blocklisted from a session: with POST /v3/blocklist/add/, from the console, or with a list entry created from reference_session_id. It does not include values added to a list by hand, uploaded faces, faces taken from a document-capture selfie, or IP address, device fingerprint, wallet, bank account, user and business entries. Read those with GET /v3/lists/{list_uuid}/entries/ on the matching system blocklist.
\- face_image and front_image are short-lived signed URLs, issued again on every call; a scoped key without media: read gets null instead.

Query parameters (all optional):
\- item_type: "face" | "document" | "phone" | "email". When omitted, every type is returned.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

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

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].type, session_id, session_number, blocklisted_at.
\- face items: face_image.
\- document items: document_type (for example "P" passport, "ID" national ID, "DL" driver's license), document_number, front_image.
\- phone items: phone_number (E.164), country_code (ISO 3166-1 alpha-2).
\- email items: email.

Failure modes:
\- 400: an unknown item_type, 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 Lista as faces, os documentos de identidade, os números de telefone e os endereços de e-mail das suas sessões de verificação que estão atualmente na lista de bloqueio, do mais recente para o mais antigo. Cada item aponta para a sessão de onde provém, para que possa abri-la na consola ou obter a respetiva decisão.Este feed mostra o que foi colocado na lista de bloqueio **a partir de uma sessão**: com [Adicionar à lista de bloqueio](https://docs.didit.me/pt/management-api/blocklist/add.md), a partir da consola, ou com uma [entrada de lista](https://docs.didit.me/pt/management-api/lists/create-entry.md) criada a partir de `reference_session_id`. Os valores introduzidos numa lista, as [faces carregadas](https://docs.didit.me/pt/management-api/lists/upload-face.md), as faces obtidas a partir de uma selfie da captura de documento e os restantes tipos de entrada (endereço IP, impressão digital do dispositivo, carteira, conta bancária, utilizador e empresa) existem apenas nas listas de bloqueio do sistema: consulte-os com [Listar entradas](https://docs.didit.me/pt/management-api/lists/list-entries.md).Consulte [Bloquear utilizadores](https://docs.didit.me/pt/console/blocklist-users.md) para saber como funciona o bloqueio na consola. ## OpenAPI ````yaml pt/openapi-25.json GET /v3/blocklist/ 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/blocklist/: get: tags: - Blocklist summary: Listar itens na lista de bloqueio description: >- Devolve um feed paginado dos rostos, documentos de identificação, números de telefone e endereços de e-mail das sessões de verificação da aplicação que estão atualmente na lista de bloqueio, ordenados pelo `blocklisted_at` mais recente primeiro; filtre com `item_type`. Os itens de sessões eliminadas não são incluídos. O feed abrange registos colocados na lista de bloqueio a partir de uma sessão (com [Adicionar itens de sessão à lista de bloqueio](https://docs.didit.me/pt/management-api/blocklist/add), a partir da consola ou através de uma entrada de lista criada a partir de uma sessão); valores adicionados a uma lista manualmente, rostos carregados, rostos de uma selfie de captura de documento e os outros tipos de entrada são consultados com [Listar entradas da lista](https://docs.didit.me/pt/management-api/lists/list-entries). `face_image` e `front_image` são URLs assinados de curta duração, e uma chave de API com âmbito restrito sem `media: read` recebe `null`. Uma chave de API com âmbito restrito necessita de `workflows: read`. operationId: list_blocklist_items parameters: - name: item_type in: query required: false description: >- Apenas itens deste tipo. Quando omitido, são devolvidos todos os tipos. schema: type: string enum: - face - document - phone - email - name: limit in: query required: false description: >- Tamanho da página. A predefinição é 50. Um valor superior a 1000000 devolve `400`; zero, um valor negativo ou um valor não numérico reverte para 50. schema: type: integer default: 50 minimum: 1 maximum: 1000000 - name: offset in: query required: false description: >- Índice de base zero do primeiro item a devolver. Prefira seguir `next`. Um valor superior a 1000000 devolve `400`; um valor negativo ou não numérico reverte para 0. schema: type: integer maximum: 1000000 minimum: 0 default: 0 responses: '200': description: Uma página de itens na lista de bloqueio, os mais recentes primeiro. content: application/json: schema: type: object required: - count - next - previous - results properties: count: type: integer minimum: 0 description: >- Número total de itens na lista de bloqueio correspondentes aos filtros. next: type: string format: uri nullable: true description: >- URL absoluto da página seguinte, ou `null` na última página. previous: type: string format: uri nullable: true description: >- URL absoluto da página anterior, ou `null` na primeira página. results: type: array items: $ref: '#/components/schemas/BlocklistedItem' examples: Mixed feed: value: count: 2 next: null previous: null results: - type: document session_id: 33333333-4444-5555-6666-777777777777 session_number: 1042 blocklisted_at: '2026-10-12T10:06:12.701553Z' face_image: null document_type: ID document_number: X1234567 front_image: >- https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47 phone_number: null country_code: null email: null - type: phone session_id: 77777777-8888-9999-0000-111111111111 session_number: 1017 blocklisted_at: '2026-10-08T15:31:09.400127Z' face_image: null document_type: null document_number: null front_image: null phone_number: '+14155552671' country_code: US email: null '400': description: Um parâmetro de consulta é inválido. content: application/json: examples: Unknown item type: value: item_type: - '"wallet" is not a valid choice.' Limit too large: value: - limit must not exceed 1000000. '401': description: >- A chave de API com âmbito expirou. Outras falhas de autenticação devolvem `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- O cabeçalho `x-api-key` está em falta (uma chave errada, revogada ou expirada recebe `401`), ou uma chave de API com âmbito não tem `workflows: read` ou é utilizada 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 de leitura partilhado de 600 pedidos por minuto por chave de API foi excedido. Respeite o `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/blocklist/?item_type=document' \ -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.blocklist.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.blocklist.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\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.blocklist().list()) { System.out.println(item); } - lang: php label: PHP source: |- blocklist->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.blocklist.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.Blocklist.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: BlocklistedItem: type: object description: >- Um rosto, documento de identidade, número de telefone ou endereço de e-mail na lista de bloqueio de uma sessão de verificação. Os campos que não se aplicam ao `type` do item são `null`. required: - type - session_id - session_number - blocklisted_at - face_image - document_type - document_number - front_image - phone_number - country_code - email properties: type: type: string enum: - face - document - phone - email description: O que foi adicionado à lista de bloqueio. session_id: type: string format: uuid description: Sessão de verificação à qual o item pertence. session_number: type: integer nullable: true description: >- Número dessa sessão no âmbito da aplicação, como mostrado na consola. blocklisted_at: type: string format: date-time description: Quando o item foi adicionado à lista de bloqueio pela última vez. face_image: type: string nullable: true description: >- Itens de rosto: URL assinado de curta duração, emitido novamente a cada chamada; `null` para uma chave de API com âmbito sem `media: read`. Também `null` quando nenhuma imagem de referência estiver guardada. document_type: type: string nullable: true description: >- Itens de documento: código do tipo de documento, por exemplo `P` (passaporte), `ID` (documento de identificação nacional), `DL` (carta de condução) ou `RP` (autorização de residência). document_number: type: string nullable: true description: >- Itens de documento: o número do documento, ou o número de identificação pessoal quando o documento não tiver nenhum. front_image: type: string nullable: true description: >- Itens de documento: imagem da frente do documento, URL assinado de curta duração, emitido novamente a cada chamada; `null` para uma chave de API com âmbito restrito sem `media: read`. phone_number: type: string nullable: true description: 'Itens de telefone: o número de telefone em E.164.' country_code: type: string nullable: true description: 'Itens de telefone: país ISO 3166-1 alpha-2 do número.' email: type: string nullable: true description: 'Itens de e-mail: o endereço de e-mail.' securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.