> ## 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/ko/management-api/lists/list-entries.md)을 참조하세요.


## OpenAPI

````yaml ko/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`를 반환합니다. 이 요청은 목록 자체만 반환합니다. 목록의 값을 읽으려면 [List list
        entries](https://docs.didit.me/ko/management-api/lists/list-entries)를
        사용하세요. 범위가 지정된 API 키에는 `workflows: read` 권한이 필요합니다.
      operationId: get_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: 목록 조회(List lists) 또는 목록 생성(Create a list)에서 반환된 목록의 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`(IP 주소 또는 CIDR 범위), `device_fingerprint`,
            `wallet_address`, `bank_account`, `country`(ISO 3166-1 alpha-3),
            `user` 또는 `business`(귀하의 `vendor_data`), 또는 `key`(모든 문자열)입니다. 항목 값이
            검증되고 일치되는 방식을 결정합니다.
        is_system:
          type: boolean
          description: >-
            Didit이 제공하는 목록의 경우 `true`입니다. 항목 유형당 하나의 차단 목록(`face`, `document`,
            `phone`, `email`, `ip_address`, `device_fingerprint`,
            `wallet_address`, `bank_account`, `user`, `business`), **고위험 국가** 맞춤
            목록 및 시스템 허용 목록이 해당됩니다. 시스템 목록은 이름을 변경하거나 편집 또는 삭제할 수 없으며, 항목의 추가 및
            삭제만 가능합니다.
        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: >-
        Business Console의 Developers -> API keys에서 발급받은 귀하 애플리케이션의 API 키입니다. 기본
        키는 전체 접근 권한을 갖습니다. 이름이 지정된 키는 리소스별 none, read, write 범위로 권한을 제한할 수 있으며
        특정 워크플로나 승인된 세션, IP 주소 목록, 만료일 등으로 제한할 수도 있습니다. 401은 키가 잘못되었거나 폐기되었거나
        만료되었음을 의미합니다. 403은 키가 전송되지 않았거나, 키에 해당 리소스나 작업에 대한 접근 권한이 없거나, 요청이 허용된
        IP 목록 외부 주소에서 발생했음을 의미합니다. 세션 경로에서의 404는 해당 세션이 키의 허용 워크플로 또는 상태 범위를
        벗어났음을 의미합니다. 미디어 접근 권한이 없는 키는 이미지, 비디오, PDF URL을 null로 수신하며, 세션 write
        권한이 없는 키는 세션 링크와 token을 null로 수신합니다.
        https://docs.didit.me/console/api-keys 를 참고하십시오.

````

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