> ## 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 entradas de listas de bloqueio e permissões > GET /v3/lists/{list_uuid}/entries/: obtenha as entradas paginadas de uma lista da Didit, com pesquisa. Pago por chamada. Prompt da API de entradas de listas Copiar o prompt para a área de transferência \

\`Retrieve paginated entries from a Didit list through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/{list_uuid}/entries/

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

Goal:
\- Browse, search, or export the entries inside a specific list (blocklist, allowlist, or custom).

Path parameter:
\- list_uuid: the list UUID from GET /v3/lists/.

Query parameters (all optional):
\- search: case-insensitive text that value or display_label must contain.
\- reference_session_id: only the entries taken from this person verification session (for example, to see which of its faces are already in the face blocklist). Must be a session UUID.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Behavior:
\- Current entries only, newest first.
\- Image URLs in metadata (reference_image_url, front_image_url) are short-lived signed URLs, issued again on every call. A scoped key without media: read gets null in their place.

Example call:
curl -X GET "https://verification.didit.me/v3/lists/{list_uuid}/entries/?search=example.com" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].uuid: entry id; use it as entry_uuid in DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/.
\- results[].value: the listed value (phone number in E.164, email, document number, IP or CIDR range, wallet address, country code, vendor_data, or a face UUID on face lists). Matching is case-insensitive.
\- results[].display_label, comment: labels and notes.
\- results[].added_by: "api" (an API key), a console user's email or "console", "system" (entries Didit provisions), or "rule" (a transaction rule action).
\- results[].reference_session_id / reference_session_number / reference_session_type: set when the entry was taken from a verification session; reference_session_type is "kyc" or "kyb".
\- results[].reference_object_uuid + metadata.reference_type: the record the entry stands for. metadata.reference_type, when you set it, says whether reference_object_uuid is a "transaction", a "vendor_user" or a "vendor_business".
\- results[].metadata: may include document context (full_name, issuing_state, document_type, document_number), face image URLs, and, for faces from a document-capture selfie, face_image_source and reference_node_id.

Failure modes:
\- 400: reference_session_id is not a valid UUID, 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.
\- 404: no list with this UUID in this application, or it was deleted ({ "detail": "List not found." }).
\- 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 Obtém as entradas de uma lista, das mais recentes para as mais antigas, com pesquisa opcional. `search` corresponde a parte do valor ou da etiqueta de uma entrada, sem distinguir maiúsculas de minúsculas. `reference_session_id` restringe os resultados às entradas obtidas de uma sessão de verificação. Numa lista facial, `metadata.face_image_source` indica a qual das faces da sessão corresponde cada entrada (`liveness` quando está ausente).As entradas faciais e de documentos incluem, em `metadata`, URLs de imagens que expiram pouco depois da chamada. Obtenha as entradas novamente para receber URLs novos, em vez de os armazenar. Uma chave de API sem **media: read** recebe `null` nesses URLs. ## OpenAPI ````yaml pt/openapi-25.json GET /v3/lists/{list_uuid}/entries/ 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/{list_uuid}/entries/: get: tags: - Lists summary: Listar entradas da lista description: >- Devolve as entradas atuais de uma lista, ordenadas pela mais recente primeiro. `search` faz a correspondência parcial com o `value` ou `display_label` de uma entrada, sem diferenciar maiúsculas de minúsculas, e `reference_session_id` restringe os resultados às entradas obtidas a partir de uma sessão de verificação de pessoa. Os URLs de imagens em `metadata` são URLs assinados de curta duração emitidos novamente a cada chamada; uma chave de API com âmbito restrito sem `media: read` recebe `null` no seu lugar. Uma chave de API com âmbito restrito necessita de `workflows: read`. operationId: list_list_entries parameters: - name: list_uuid in: path required: true description: >- UUID da lista, conforme retornado por Listar listas ou Criar uma lista. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 - name: search in: query required: false description: >- Texto insensível a maiúsculas/minúsculas que o `value` ou `display_label` da entrada deve conter. schema: type: string - name: reference_session_id in: query required: false description: >- Apenas as entradas recolhidas a partir desta sessão de verificação de pessoa, por exemplo para consultar quais dos seus rostos já estão listados. schema: type: string format: uuid - 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 entradas, as 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 entradas 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/ComplianceListEntry' examples: Entries: value: count: 2 next: null previous: null results: - uuid: bbbbbbbb-cccc-dddd-eeee-ffffffffffff value: X1234567 display_label: Jane Doe - X1234567 comment: '' added_by: api reference_session_id: 33333333-4444-5555-6666-777777777777 reference_session_number: 1042 reference_session_type: kyc reference_object_uuid: 66666666-7777-8888-9999-000000000000 metadata: full_name: Jane Doe issuing_state: ESP document_type: ID region: '' document_number: X1234567 created_at: '2026-10-12T10:06:12.774915Z' - uuid: eeeeeeee-ffff-0000-1111-222222222222 value: y7654321 display_label: '' comment: Reported by a partner added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: null metadata: null created_at: '2026-10-03T07:48:30.552810Z' '400': description: Um parâmetro de consulta é inválido. content: application/json: examples: Invalid session id: value: reference_session_id: - Must be a valid UUID. 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. '404': description: >- Não existe nenhuma lista com este UUID na aplicação da chave de API, ou foi eliminada. content: application/json: examples: Not found: value: detail: List not found. '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/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com' \ -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.entries.list( "11111111-2222-3333-4444-555555555555", ): 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.entries.list("11111111-2222-3333-4444-555555555555")) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.Entries.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesListParams{})\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().entries().list("11111111-2222-3333-4444-555555555555")) { System.out.println(item); } - lang: php label: PHP source: >- lists->entries->list('11111111-2222-3333-4444-555555555555') as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.lists.entries.list("11111111-2222-3333-4444-555555555555").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.Entries.ListAsync("11111111-2222-3333-4444-555555555555")) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: ComplianceListEntry: type: object description: Um valor numa lista. required: - uuid - value - display_label - comment - added_by - reference_session_id - reference_session_number - reference_session_type - reference_object_uuid - metadata - created_at properties: uuid: type: string format: uuid description: >- Identificador da entrada. Utilize-o como `entry_uuid` em Eliminar uma entrada da lista. value: type: string description: >- O valor listado: um número de telefone em E.164, um endereço de e-mail, um número de documento, um endereço IP ou intervalo CIDR, uma impressão digital do dispositivo, um endereço de carteira, uma conta bancária, um código de país ISO 3166-1 alfa-3, um `vendor_data`, qualquer cadeia de carateres numa lista de `key`, ou o UUID do rosto armazenado numa lista de rostos. Os valores que envia são armazenados em minúsculas, exceto números de telefone e códigos de país. A correspondência não diferencia maiúsculas de minúsculas. display_label: type: string nullable: true maxLength: 512 description: >- Rótulo legível. A Didit preenche-o para entradas obtidas de uma sessão (por exemplo, o nome do titular e o número do documento) quando não envia nenhum. comment: type: string description: Nota em texto livre. String vazia quando não definida. added_by: type: string nullable: true description: >- Quem adicionou a entrada: `api` (uma chave de API), o endereço de e-mail de um utilizador da consola ou `console`, `system` ou `migration` (entradas criadas pela Didit), ou `rule` (uma ação de regra de transação ou de monitorização). reference_session_id: type: string format: uuid nullable: true description: >- Sessão de verificação da qual a entrada foi retirada. `null` quando a entrada foi adicionada por valor. reference_session_number: type: integer nullable: true description: >- Número dessa sessão no âmbito da aplicação, como mostrado na consola. reference_session_type: type: string nullable: true enum: - kyc - kyb - null description: >- `kyc` para uma sessão de verificação de pessoa, `kyb` para uma sessão de verificação de empresa, `null` quando não existe sessão. reference_object_uuid: type: string format: uuid nullable: true description: >- O registo que a entrada representa: o registo de rosto, documento, telefone ou e-mail lido a partir de uma sessão, o rosto criado por Carregar um rosto para uma lista, ou o UUID que enviou (por exemplo, o UUID de uma transação ou o `didit_internal_id` de um utilizador). metadata: type: object nullable: true additionalProperties: true description: >- Contexto adicional. Contém as chaves definidas pela Didit (aqui listadas) combinadas com quaisquer `metadata` que tenha enviado ao criar a entrada, devolvidas conforme armazenadas. `null` quando não existir nenhum. properties: reference_image_url: type: string description: >- Entradas de rosto: URL assinado de curta duração, emitido novamente a cada chamada; `null` para uma chave de API com âmbito sem `media: read`. Ausente quando não existir nenhuma imagem associada à entrada. front_image_url: type: string description: >- Entradas de documentos que contêm uma 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`. full_name: type: string description: >- Entradas de documentos obtidas de uma sessão: nome completo do titular. issuing_state: type: string description: >- Entradas de documentos obtidas de uma sessão: país emissor ISO 3166-1 alfa-3. document_type: type: string description: >- Entradas de documentos obtidas de uma sessão: código do tipo de documento, por exemplo `P`, `ID` ou `DL`. region: type: string description: >- Entradas de documentos obtidas de uma sessão: estado ou província de emissão de um documento emitido regionalmente, vazio quando não aplicável. Não definido por Adicionar itens da sessão à lista de bloqueio. document_number: type: string description: >- Entradas de documentos obtidas de uma sessão: o número do documento. face_image_source: type: string enum: - front_image_camera_front - back_image_camera_front description: >- Entradas de rosto obtidas a partir de uma selfie de captura de documento: qual é a selfie. Ausente para rostos de prova de vida. reference_node_id: type: string nullable: true description: >- Entradas de rosto obtidas a partir de uma selfie de captura de documento: o nó de Verificação de identidade de onde a selfie teve origem. fingerprint_tier: type: string nullable: true enum: - persistent_id - composite_hash - legacy_fp - unknown - null description: >- Entradas da impressão digital do dispositivo recolhidas de uma sessão: como a impressão digital foi obtida. O `persistent_id` identifica um dispositivo; o `composite_hash` e o `legacy_fp` podem ser partilhados por dispositivos do mesmo modelo. sandbox: type: boolean description: >- `true` numa entrada facial carregada numa aplicação de sandbox; essa entrada não corresponde a nada. reference_type: type: string enum: - transaction - vendor_user - vendor_business description: >- Definido por si: para o que aponta `reference_object_uuid`, para que a consola possa criar uma ligação para o mesmo. reference_id: type: string description: 'Definido por si: identificador do registo de origem.' created_at: type: string format: date-time description: Quando a entrada foi adicionada. 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.