> ## 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}/entries/：Diditのブロックリスト、許可リスト、カスタムリストのエントリーを検索フィルター付きでページネーション取得します。呼び出しごとの従量課金です。 リストエントリーAPIのプロンプト プロンプトをクリップボードにコピー \

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

\
貼り付け先 1つのリストのエントリーを新しい順に取得します。任意で検索もできます。`search`は、エントリーの値またはラベルの一部に大文字・小文字を区別せずに一致します。`reference_session_id`を指定すると、1つの認証セッションから取り込まれたエントリーに結果を絞り込めます。顔リストでは、`metadata.face_image_source`により、各エントリーがセッション内のどの顔に対応するかがわかります(存在しない場合は`liveness`)。顔と書類のエントリーは、`metadata`に画像URLを含みます。これらのURLは呼び出しから間もなく期限切れになります。URLを保存せず、新しいURLが必要なときはエントリーを再度取得してください。**media: read**を持たないAPIキーでは、これらのURLは`null`として返されます。 ## OpenAPI ````yaml ja/openapi-25.json GET /v3/lists/{list_uuid}/entries/ 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}/entries/: get: tags: - Lists summary: リストのエントリを一覧表示 description: >- 1つのリストの現在のエントリを新しい順に返します。`search`はエントリの`value`または`display_label`の一部に大文字と小文字を区別せずに一致し、`reference_session_id`は個人の認証セッション1件から取得したエントリに結果を絞り込みます。`metadata`内の画像URLは呼び出しのたびに再発行される有効期間の短い署名付きURLです。`media: read`を持たないスコープ付きAPIキーには、その代わりに`null`が返されます。スコープ付きAPIキーには`workflows: read`が必要です。 operationId: list_list_entries 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 - name: search in: query required: false description: エントリーの`value`または`display_label`に含まれている必要がある、大文字・小文字を区別しないテキスト。 schema: type: string - name: reference_session_id in: query required: false description: >- この本人認証セッションから取得されたエントリのみ。例えば、そのセッションの顔のうちどれがすでに登録されているかを確認する場合に使用します。 schema: type: string format: uuid - name: limit in: query required: false description: ページサイズ。デフォルトは50です。1000000を超える値は`400`を返します。0、負の値、数値以外の値の場合は50が使用されます。 schema: type: integer default: 50 minimum: 1 maximum: 1000000 - name: offset in: query required: false description: >- 返す最初の項目の0始まりのインデックスです。`next`をたどる方法を推奨します。1000000を超える値は`400`を返し、負の値または数値以外の値は0として扱われます。 schema: type: integer maximum: 1000000 minimum: 0 default: 0 responses: '200': description: エントリーのページ（新しい順）。 content: application/json: schema: type: object required: - count - next - previous - results properties: count: type: integer minimum: 0 description: フィルターに一致するエントリーの総数。 next: type: string format: uri nullable: true description: 次のページの絶対URL。最後のページでは`null`になります。 previous: type: string format: uri nullable: true description: 前のページの絶対URL。最初のページでは`null`になります。 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: クエリパラメーターが無効です。 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: スコープ付き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: List not found. '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/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: リスト内の1つの値です。 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: エントリの識別子。「リストエントリの削除」で`entry_uuid`として使用します。 value: type: string description: >- 登録された値です。E.164形式の電話番号、メールアドレス、書類番号、IPアドレスまたはCIDR範囲、デバイスフィンガープリント、ウォレットアドレス、銀行口座、ISO 3166-1 alpha-3の国コード、`vendor_data`、`key`リスト上の任意の文字列、または顔リスト上の保存された顔のUUIDのいずれかです。送信した値は、電話番号と国コードを除き小文字で保存されます。照合では大文字と小文字は区別されません。 display_label: type: string nullable: true maxLength: 512 description: 人が読めるラベル。送信しない場合、セッションから取得したエントリについてはDiditが自動で設定します（例：保有者の氏名と書類番号）。 comment: type: string description: 自由記述のメモ。未設定の場合は空文字列です。 added_by: type: string nullable: true description: >- エントリを追加した主体：`api`（APIキー）、コンソールユーザーのメールアドレスまたは`console`、`system`または`migration`（Diditが作成したエントリ）、あるいは`rule`（取引ルールまたはモニタリングルールのアクション）。 reference_session_id: type: string format: uuid nullable: true description: エントリーの取得元となった認証セッション。エントリーが値で追加された場合は`null`です。 reference_session_number: type: integer nullable: true description: そのセッションのアプリケーション単位の番号。コンソールに表示される番号と同じです。 reference_session_type: type: string nullable: true enum: - kyc - kyb - null description: 個人の認証セッションの場合は`kyc`、企業の認証セッションの場合は`kyb`、セッションがない場合は`null`。 reference_object_uuid: type: string format: uuid nullable: true description: >- エントリが表すレコード: セッションから読み取った顔、書類、電話番号またはメールアドレスのレコード、Upload a face to a listで作成された顔、または送信したUUID（例: 取引のUUIDやユーザーの`didit_internal_id`）。 metadata: type: object nullable: true additionalProperties: true description: >- 追加コンテキストです。Diditが設定するキー(ここに記載)と、エントリー作成時に送信した`metadata`をマージし、保存されたとおりに返します。ない場合は`null`です。 properties: reference_image_url: type: string description: >- 顔エントリー：有効期間の短い署名付きURLで、呼び出しのたびに再発行されます。`media: read`を持たないスコープ付きAPIキーの場合は`null`です。エントリーに画像が紐づいていない場合は含まれません。 front_image_url: type: string description: >- 書類の表面画像を持つ書類エントリ: 有効期間の短い署名付きURLで、呼び出しのたびに再発行されます。`media: read`を持たないスコープ付きAPIキーの場合は`null`。 full_name: type: string description: 'セッションから取得した書類エントリ: 所持者の氏名。' issuing_state: type: string description: 'セッションから取得した書類エントリ: ISO 3166-1 alpha-3形式の発行国。' document_type: type: string description: 'セッションから取得した書類エントリ: 書類種別コード。例: `P`、`ID`、`DL`。' region: type: string description: >- セッションから取得した書類エントリ: 地域単位で発行された書類の発行州または県。該当しない場合は空。Add session items to the blocklistでは設定されません。 document_number: type: string description: 'セッションから取得した書類エントリ: 書類番号。' face_image_source: type: string enum: - front_image_camera_front - back_image_camera_front description: 書類撮影時のセルフィーから取得された顔エントリー：どのセルフィーか。ライブネスの顔の場合は含まれません。 reference_node_id: type: string nullable: true description: 書類撮影時のセルフィーから取得された顔エントリー：そのセルフィーの取得元である本人確認ノード。 fingerprint_tier: type: string nullable: true enum: - persistent_id - composite_hash - legacy_fp - unknown - null description: >- セッションから取得したデバイスフィンガープリントのエントリで、フィンガープリントがどのように導出されたかを示します。`persistent_id`は1台のデバイスを識別します。`composite_hash`と`legacy_fp`は同じモデルのデバイス間で共有される場合があります。 sandbox: type: boolean description: サンドボックスアプリケーションでアップロードされた顔エントリでは`true`です。このようなエントリは何にも一致しません。 reference_type: type: string enum: - transaction - vendor_user - vendor_business description: >- お客様が設定: `reference_object_uuid`が指す対象。コンソールからそのレコードへリンクするために使われます。 reference_id: type: string description: 'お客様が設定: ソースレコードの識別子。' created_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.