> ## 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：查询合规名单

> 通过 GET /v3/lists/{list_uuid}/ 检索 Didit 黑名单、白名单或自定义名单的详情，包括条目数量和元数据。



获取列表 API 提示词
        将提示词复制到剪贴板



      
      

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



      
      

粘贴到

获取单个列表的详情，包括其条目数量以及最新条目的添加时间。属于其他应用的列表，或已删除的列表，将返回 `404`。如需读取列表中的值，请使用[列表条目](https://docs.didit.me/zh/management-api/lists/list-entries.md)。


## OpenAPI

````yaml zh/openapi-25.json GET /v3/lists/{list_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: 身份证件验证 API。使用 x-api-key 请求头进行身份验证。
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/lists/{list_uuid}/:
    get:
      tags:
        - Lists
      summary: 获取列表
      description: >-
        返回该应用的一个列表及其条目数量和最新条目的添加时间。属于其他应用或已被删除的列表将返回
        `404`。此接口仅返回列表本身：如需读取其具体值，请使用[获取列表条目](https://docs.didit.me/zh/management-api/lists/list-entries)。有作用域限制的
        API 密钥需要 `workflows: read` 权限。
      operationId: get_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: 列表的 UUID，如列出列表或创建列表所返回。
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      responses:
        '200':
          description: 名单。
          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: 作用域 API 密钥已过期。其他身份验证失败将返回 `403`。
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            缺少 `x-api-key` 请求头（错误、已撤销或已过期的密钥会返回 `401`），或者限定权限的 API 密钥缺少
            `workflows: read`，抑或是从其允许名单之外的 IP 地址使用。
          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: API 密钥所属的应用中不存在具有此 UUID 的列表，或者已被删除。
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '429':
          description: 已超出每个 API 密钥每分钟 600 次请求的共享读取限制。在重试之前请遵循 `Retry-After`。
          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: 某个应用的黑名单、白名单或自定义名单。
      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: >-
            名单标识符。在名单和条目 endpoint 中用作 `list_uuid`，并在带有 `value_type: "list"`
            的工作流或交易规则条件中用作值。
        name:
          type: string
          maxLength: 255
          description: 名单名称，在应用的各个名单中具有唯一性。
        description:
          type: string
          description: 自由文本描述。未设置时为空字符串。
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist`：匹配会拒绝会话或交易（仅限系统名单，每种条目类型一个）。`allowlist`：匹配的项目受信任，例如人脸白名单会跳过重复人脸操作；绝不会覆盖黑名单匹配。`custom`：用于工作流和交易规则条件（`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: >-
            该名单包含的内容：`face`、`document`（证件号码）、`phone`、`email`、`ip_address`（地址或
            CIDR
            范围）、`device_fingerprint`、`wallet_address`、`bank_account`、`country`（ISO
            3166-1 alpha-3）、`user` 或 `business`（您的 `vendor_data`），或
            `key`（任意字符串）。它决定了条目值的验证和匹配方式。
        is_system:
          type: boolean
          description: >-
            `true` 表示由 Didit
            预配的名单：每种条目类型一个黑名单（`face`、`document`、`phone`、`email`、`ip_address`、`device_fingerprint`、`wallet_address`、`bank_account`、`user`、`business`）、**High
            Risk Countries** 自定义名单以及系统白名单。系统名单无法重命名、编辑或删除；您可以添加和删除其中的条目。
        entry_count:
          type: integer
          minimum: 0
          description: 当前列表中条目的数量。
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: 添加最新当前条目的时间。名单为空时为 `null`。
        created_at:
          type: string
          format: date-time
          description: 名单创建时间。
        updated_at:
          type: string
          format: date-time
          description: 名单最后更新时间。
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        您的应用 API 密钥，可在 Business Console 的“开发者 -> API
        密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
        IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
        列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
        URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
        https://docs.didit.me/console/api-keys。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.