> ## 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 Obter lista: consultar lista de conformidade

> GET /v3/lists/{list_uuid}/: obtenha detalhes de uma lista de bloqueio, de permissões ou personalizada da Didit, com total de entradas e metadados.



Prompt da API para obter lista
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Fetch a single Didit list's metadata through the Management API.

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

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

Goal:
\- Retrieve the details of a specific list: name, description, list_type, entry_type, is_system, entry_count, last_entry_added_at.
\- Use this to render a list-detail view or to confirm a list still exists before adding entries.

Path parameter:
\- list_uuid: the list UUID returned by GET /v3/lists/ or POST /v3/lists/.

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

What to read from the response:
\- list_type: "blocklist" | "allowlist" | "custom" (drives what a match does).
\- entry_type: decides how values are validated and which data is matched.
\- is_system: true for the lists Didit provisions (one blocklist per entry type, the "High Risk Countries" list, any system allowlist). These cannot be renamed, edited or deleted.
\- entry_count, last_entry_added_at: computed over the list's current entries.

This endpoint returns the list metadata only. To fetch entries, call GET /v3/lists/{list_uuid}/entries/.

Failure modes:
\- 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": "No List matches the given query." }).
\- 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.`

\</pre>



      
      

Colar em

Obtenha os detalhes de uma lista, incluindo a quantidade de entradas e a data em que a entrada mais recente foi adicionada. Uma lista de outra aplicação, ou uma lista que foi excluída, retorna `404`.Para ler os valores da lista, use [Listar entradas](https://docs.didit.me/pt-br/management-api/lists/list-entries.md).


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/lists/{list_uuid}/
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}/:
    get:
      tags:
        - Lists
      summary: Obter uma lista
      description: >-
        Retorna uma lista da aplicação com a contagem de entradas e o momento em
        que a entrada mais recente foi adicionada. Uma lista de outra aplicação,
        ou uma lista que foi excluída, retorna `404`. Este endpoint retorna
        apenas a lista: leia os valores dela com [Listar entradas da
        lista](https://docs.didit.me/pt-br/management-api/lists/list-entries).
        Uma chave de API com escopo precisa de `workflows: read`.
      operationId: get_list
      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
      responses:
        '200':
          description: A lista.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceList'
              examples:
                System face blocklist:
                  value:
                    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'
        '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.
        '404':
          description: >-
            Não existe nenhuma lista com este UUID na aplicação da chave de API,
            ou ela foi excluída.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '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/11111111-2222-3333-4444-555555555555/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.retrieve(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.lists.retrieve("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.lists().retrieve("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->lists->retrieve('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.lists.retrieve("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
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.