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

> Didit 세션에서 차단 목록에 등록된 얼굴, 문서, 전화번호, 이메일을 최신순 단일 피드로 조회합니다. GET /v3/blocklist/



차단된 항목 목록 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/ko/management-api/blocklist/add.md) 기능, 콘솔, 또는 `reference_session_id`로 만든 [목록 항목](https://docs.didit.me/ko/management-api/lists/create-entry.md)을 통해 차단된 항목입니다. 목록에 직접 입력한 값, [업로드된 얼굴](https://docs.didit.me/ko/management-api/lists/upload-face.md), 문서 촬영 셀피에서 가져온 얼굴, 그리고 그 밖의 항목 유형(IP 주소, 기기 지문, 지갑, 은행 계좌, 사용자, 기업)은 시스템 차단 목록에만 존재합니다. 이들은 [목록 항목 조회](https://docs.didit.me/ko/management-api/lists/list-entries.md) API로 읽을 수 있습니다.콘솔에서 차단이 어떻게 작동하는지는 [사용자 차단](https://docs.didit.me/ko/console/blocklist-users.md)을 참고하십시오.


## OpenAPI

````yaml ko/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` 순으로 반환합니다. `item_type`으로 필터링할 수 있습니다. 삭제된 세션의 항목은 포함되지
        않습니다. 이 피드는 세션에서 차단 목록에 등록된 레코드([세션 항목을 차단 목록에
        추가](https://docs.didit.me/ko/management-api/blocklist/add), 콘솔에서 추가, 또는
        세션에서 생성된 목록 항목을 통해 추가)를 다룹니다. 수동으로 목록에 추가된 값, 업로드된 얼굴, 신분증 촬영 셀피에서 추출된
        얼굴 및 기타 항목 유형은 [목록 항목
        조회](https://docs.didit.me/ko/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`(주민등록증/신분증), `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: >-
        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.