> ## 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プロンプト プロンプトをクリップボードにコピー \

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

\
貼り付け先 1件のリストの詳細を取得します。エントリー数と、最新のエントリーが追加された日時も含まれます。別のアプリケーションのリスト、または削除されたリストを指定すると`404`が返されます。リスト内の値を読み取るには、[エントリー一覧](https://docs.didit.me/ja/management-api/lists/list-entries.md)を使用してください。 ## OpenAPI ````yaml ja/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: >- アプリケーションのリストを1件、そのエントリー数と最新のエントリーが追加された日時とともに返します。別のアプリケーションのリスト、または削除されたリストの場合は`404`が返されます。このエンドポイントが返すのはリストのみです。リストの値を読み取るには[リストエントリーの一覧取得](https://docs.didit.me/ja/management-api/lists/list-entries)を使用してください。スコープ付きAPIキーには`workflows: read`が必要です。 operationId: get_list parameters: - name: list_uuid in: path required: true description: リストのUUIDです。List listsまたはCreate a listで返される値を指定します。 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: このUUIDのリストがAPIキーのアプリケーションに存在しないか、削除されています。 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: >- 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: 1つのアプリケーションのブロックリスト、許可リスト、またはカスタムリスト。 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: >- リストの識別子です。リストおよびエントリのエンドポイントでは`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`：一致するとセッションまたは取引が却下されます（システムリストのみ、エントリタイプごとに1つ）。`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`です。対象は、エントリタイプごとに1つずつ用意されるブロックリスト（`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のDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.