> ## 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/blocklist/：Diditのセッションでブロックリストに登録された顔、書類、電話番号、メールアドレスを、新しい順に1つのフィードで一覧取得します。



ブロックリスト登録項目一覧取得APIのプロンプト
        プロンプトをクリップボードにコピー



      
      

\<pre>

\`List the blocklisted faces, documents, phone numbers and email addresses of my Didit verification sessions through the Management API.

Endpoint:
GET https://verification.didit.me/v3/blocklist/

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

Goal:
\- Get one paginated feed of every session record that is currently blocklisted, to build a "Blocked" screen or audit what my team has blocked.

Behavior:
\- Items are sorted by blocklisted_at, newest first. Items of deleted sessions are not included.
\- Each item has a type ("face", "document", "phone" or "email") and the session it belongs to (session_id, session_number). Fields that do not apply to the type are null.
\- The feed covers records blocklisted from a session: with POST /v3/blocklist/add/, from the console, or with a list entry created from reference_session_id. It does not include values added to a list by hand, uploaded faces, faces taken from a document-capture selfie, or IP address, device fingerprint, wallet, bank account, user and business entries. Read those with GET /v3/lists/{list_uuid}/entries/ on the matching system blocklist.
\- face_image and front_image are short-lived signed URLs, issued again on every call; a scoped key without media: read gets null instead.

Query parameters (all optional):
\- item_type: "face" | "document" | "phone" | "email". When omitted, every type is returned.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Example call:
curl -X GET "https://verification.didit.me/v3/blocklist/?item_type=document" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].type, session_id, session_number, blocklisted_at.
\- face items: face_image.
\- document items: document_type (for example "P" passport, "ID" national ID, "DL" driver's license), document_number, front_image.
\- phone items: phone_number (E.164), country_code (ISO 3166-1 alpha-2).
\- email items: email.

Failure modes:
\- 400: an unknown item_type, 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.
\- 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>



      
      

貼り付け先

検証セッションのうち、現在ブロックリストに登録されている顔、本人確認書類、電話番号、メールアドレスを新しい順に一覧表示します。各項目は登録元のセッションを参照しているため、コンソールでそのセッションを開いたり、判定を取得したりできます。このフィードには、**セッションから**ブロックリストに登録されたものが表示されます。具体的には、[ブロックリストに追加](https://docs.didit.me/ja/management-api/blocklist/add.md)を使った登録、コンソールからの登録、または`reference_session_id`から作成した[リストエントリー](https://docs.didit.me/ja/management-api/lists/create-entry.md)による登録です。リストに直接入力した値、[アップロードした顔](https://docs.didit.me/ja/management-api/lists/upload-face.md)、書類撮影時のセルフィーから取得した顔、およびその他のエントリー種別(IPアドレス、デバイスフィンガープリント、ウォレット、銀行口座、ユーザー、企業)は、システムのブロックリストにのみ保存されます。これらは[エントリー一覧の取得](https://docs.didit.me/ja/management-api/lists/list-entries.md)で参照してください。コンソールでのブロックリスト登録の仕組みについては、[ユーザーをブロックリストに登録する](https://docs.didit.me/ja/console/blocklist-users.md)を参照してください。


## OpenAPI

````yaml ja/openapi-25.json GET /v3/blocklist/
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/blocklist/:
    get:
      tags:
        - Blocklist
      summary: ブロックリストの項目一覧を取得
      description: >-
        アプリケーションの認証セッションのうち、現在ブロックリストに登録されている顔、身分証明書類、電話番号、メールアドレスを、`blocklisted_at`の新しい順に1つのページ分割されたフィードで返します。`item_type`でフィルターできます。削除されたセッションの項目は含まれません。このフィードの対象は、セッションからブロックリストに登録されたレコード（[セッションの項目をブロックリストに追加](https://docs.didit.me/ja/management-api/blocklist/add)、コンソール、またはセッションから作成されたリストエントリによるもの）です。手動でリストに追加した値、アップロードされた顔、書類撮影時のセルフィーから取得した顔、およびその他のエントリタイプは[リストエントリの一覧取得](https://docs.didit.me/ja/management-api/lists/list-entries)で取得します。`face_image`と`front_image`は有効期間の短い署名付きURLで、`media:
        read`を持たないスコープ付きAPIキーには`null`が返されます。スコープ付きAPIキーには`workflows: read`が必要です。
      operationId: list_blocklist_items
      parameters:
        - name: item_type
          in: query
          required: false
          description: このタイプの項目のみ。省略した場合はすべてのタイプが返されます。
          schema:
            type: string
            enum:
              - face
              - document
              - phone
              - email
        - 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/BlocklistedItem'
              examples:
                Mixed feed:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - type: document
                        session_id: 33333333-4444-5555-6666-777777777777
                        session_number: 1042
                        blocklisted_at: '2026-10-12T10:06:12.701553Z'
                        face_image: null
                        document_type: ID
                        document_number: X1234567
                        front_image: >-
                          https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47
                        phone_number: null
                        country_code: null
                        email: null
                      - type: phone
                        session_id: 77777777-8888-9999-0000-111111111111
                        session_number: 1017
                        blocklisted_at: '2026-10-08T15:31:09.400127Z'
                        face_image: null
                        document_type: null
                        document_number: null
                        front_image: null
                        phone_number: '+14155552671'
                        country_code: US
                        email: null
        '400':
          description: クエリパラメーターが無効です。
          content:
            application/json:
              examples:
                Unknown item type:
                  value:
                    item_type:
                      - '"wallet" is not a valid choice.'
                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.
        '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/blocklist/?item_type=document' \
              -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.blocklist.list():
                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.blocklist.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\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.blocklist().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->blocklist->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.blocklist.list.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.Blocklist.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    BlocklistedItem:
      type: object
      description: >-
        検証セッションでブロックリストに登録された顔、身分証明書類、電話番号、またはメールアドレス1件。項目の`type`に該当しないフィールドは`null`です。
      required:
        - type
        - session_id
        - session_number
        - blocklisted_at
        - face_image
        - document_type
        - document_number
        - front_image
        - phone_number
        - country_code
        - email
      properties:
        type:
          type: string
          enum:
            - face
            - document
            - phone
            - email
          description: ブロックリストに登録された対象です。
        session_id:
          type: string
          format: uuid
          description: 項目が属する認証セッション。
        session_number:
          type: integer
          nullable: true
          description: そのセッションのアプリケーション単位の番号。コンソールに表示される番号と同じです。
        blocklisted_at:
          type: string
          format: date-time
          description: アイテムが最後にブロックリストに登録された日時。
        face_image:
          type: string
          nullable: true
          description: >-
            顔項目：有効期間の短い署名付きURLで、呼び出しのたびに再発行されます。`media:
            read`を持たないスコープ付きAPIキーの場合は`null`です。参照画像が保存されていない場合も`null`になります。
        document_type:
          type: string
          nullable: true
          description: '書類項目: 書類種別コード。例: `P`(パスポート)、`ID`(国民IDカード)、`DL`(運転免許証)、`RP`(在留許可証)。'
        document_number:
          type: string
          nullable: true
          description: '書類項目: 書類番号。書類番号がない場合は個人番号。'
        front_image:
          type: string
          nullable: true
          description: >-
            書類項目: 書類の表面画像。有効期間の短い署名付きURLで、呼び出しのたびに再発行されます。`media:
            read`を持たないスコープ付きAPIキーの場合は`null`。
        phone_number:
          type: string
          nullable: true
          description: '電話番号の項目: E.164形式の電話番号。'
        country_code:
          type: string
          nullable: true
          description: '電話番号の項目: 番号のISO 3166-1 alpha-2の国コード。'
        email:
          type: string
          nullable: true
          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.