> ## 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 (Lists API)

> Didit 차단 목록, 허용 목록, 커스텀 목록을 관리해 KYC, 사기 탐지, 거래 스크리닝에 활용하세요. 올인원 신원 인프라, 호출당 과금.



Lists API 프롬프트
        프롬프트를 클립보드에 복사



      
      

\<pre>

\`Manage Didit blocklists, allowlists, and custom lists through the Management API.

Base path:
https://verification.didit.me/v3/lists/

Authentication:
Use the x-api-key header with my Didit API key on every call.

Concepts:
\- Blocklist — system-created, one per entry type. Items in a blocklist cause automatic decline during verification or transaction screening. Cannot be deleted or renamed.
\- Allowlist: created by you, or by Didit as a system allowlist that cannot be renamed or deleted. Used in workflow conditions and to suppress duplicate/reuse actions for trusted matching items.
\- Custom — user-created. Flexible lists for workflow branching, monitoring rules, or manual review.

Supported entry_type values:
face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business, country, key.

Endpoints I should know:
\- GET /v3/lists/ — list all lists (filter by list_type, entry_type).
\- POST /v3/lists/ — create allowlist or custom list (cannot create blocklists).
\- GET /v3/lists/{list_uuid}/ — get one list.
\- PATCH /v3/lists/{list_uuid}/ — rename or update description (system lists immutable).
\- DELETE /v3/lists/{list_uuid}/ — delete allowlist/custom only. Returns 204.
\- GET /v3/lists/{list_uuid}/entries/ — paginated entries; supports search query.
\- POST /v3/lists/{list_uuid}/entries/ — add an entry by value, by reference_session_id, or by reference_object_uuid + metadata.reference_type ("transaction" | "vendor_user" | "vendor_business").
\- POST /v3/lists/{list_uuid}/entries/face-upload/: upload a base64 face image to a face blocklist or face allowlist; Didit extracts the biometric.
\- DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/ — remove an entry. For system blocklists this auto-unblocks the underlying entity.

Value validation (Create entry):
\- email — valid email address.
\- phone — valid international phone number (auto-normalized to E.164).
\- ip_address — IP or CIDR range (e.g. 10.0.0.0/8).
\- device_fingerprint: at least 8 characters among letters, digits, -, _, : and . (a blocklist refuses a fingerprint that several distinct devices have reported).
\- country — ISO 3166-1 alpha-3 (alpha-2 is accepted and converted).
\- Other types — any non-empty string. Values are case-insensitive and normalized on storage.

Traceability:
\- Pass reference_session_id when blocklisting from a verification session: Didit auto-extracts the right value (face/document/phone/email/IP/device), marks the underlying model as blocklisted, and links the entry back to the session. Didit reads the session's most recent record of that type; to list a value from an earlier record, add it by value without reference_session_id.
\- Pass reference_object_uuid plus metadata.reference_type ("transaction" | "vendor_user" | "vendor_business") when blocklisting from a transaction or vendor user/business so the console can link back to the source.

Common failure modes:
\- 400: value fails the entry_type validator or is already in the list, list_type is wrong for the operation (e.g. POST face-upload on a non-face list), reference_session_id has no data of the requested type, a system list is modified or deleted, or a list name is already used in this application (on create or rename).
\- 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 access.
\- 404: list or entry not found in this application (a list of another application also returns 404).

Side effects:
\- Adding to a system blocklist immediately blocks future matches at verification/screening time.
\- Deleting an entry from a system blocklist unblocks the matching entity.
\- Lists are referenced by workflow status_rules (value_type: "list") for runtime list checks.

For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`

\</pre>



      
      

붙여넣을 곳

Lists API를 사용하면 애플리케이션의 유형별 목록을 관리할 수 있습니다. 시스템 차단 목록은 자동으로 생성되며 인증 및 거래 스크리닝 중에 검사됩니다. 워크플로 조건에 사용할 허용 목록과 사용자 지정 목록도 만들 수 있습니다.## 개념| 유형 | 설명 |
| - | - |
| **차단 목록** | 시스템에서 생성되며 항목 유형별로 하나씩 있습니다. 차단 목록에 있는 항목은 인증 또는 거래 스크리닝 중에 자동 거부를 일으킵니다. |
| **허용 목록** | 사용자가 생성합니다. 워크플로 조건에 사용되며, 신뢰할 수 있는 일치 항목에 대해 중복/재사용 작업을 억제하는 데 사용됩니다. |
| **사용자 지정** | 사용자가 생성합니다. 워크플로 분기, 모니터링 규칙 또는 수동 검토에 사용할 수 있는 유연한 목록입니다. |## 항목 유형| 항목 유형 | 검사 시점 | 일치 시 |
| - | - | - |
| `face` | 라이브니스 감지 | 세션 거부됨 |
| `document` | 신분증 인증(OCR) | 세션 거부됨 |
| `phone` | 전화번호 인증 | 세션 거부됨 |
| `email` | 이메일 인증 | 세션 거부됨 |
| `ip_address` | 기기 및 IP 분석(CIDR 범위 지원) | 세션 거부됨 |
| `device_fingerprint` | 기기 및 IP 분석 | 세션 거부됨 |
| `wallet_address` | 거래 스크리닝 | 거래 거부됨 |
| `bank_account` | 거래 스크리닝 | 거래 거부됨 |
| `user` | 거래 스크리닝 | 사용자 차단됨 |
| `business` | 거래 스크리닝 | 기업 차단됨 |
| `country` | 워크플로 조건 | 구성 가능 |
| `key` | 사용자 지정 용도 | 구성 가능 |## 허용 목록허용 목록은 차단 목록이나 진위 검사를 무시하지 않습니다. 허용 목록은 같은 항목 유형에 대한 중복/재사용 작업만 억제합니다. 예를 들어 얼굴 허용 목록에 있는 얼굴은 `DUPLICATED_FACE` 작업을 건너뛸 수 있고, IP 허용 목록에 있는 IP는 `DUPLICATED_IP_ADDRESS` 작업을 건너뛸 수 있으며, 기기 허용 목록에 있는 기기 지문은 `DUPLICATED_DEVICE_FINGERPRINT` 작업을 건너뛸 수 있습니다. 중복 작업이 실행되지 않은 이유를 감사할 수 있도록 Didit은 여전히 허용 목록 정보성 경고를 기록합니다.## 시스템 차단 목록모든 애플리케이션은 항목 유형별로 시스템 차단 목록 10개와 시스템 **High Risk Countries** 목록을 자동으로 받습니다. 이 목록은 삭제하거나 이름을 변경할 수 없습니다. API 또는 콘솔에서 이 목록에 항목을 추가할 수 있습니다.## 추적성차단 목록의 모든 항목은 원본 엔티티에 연결할 수 있으므로 목록에서 원본 기록으로 이동할 수 있습니다.- **세션에서**: [항목 생성](https://docs.didit.me/ko/management-api/lists/create-entry.md)할 때 `reference_session_id`를 전달합니다. Didit이 값(얼굴, 문서, 전화번호, 이메일, IP 또는 기기)을 자동으로 추출하고, 기반 모델을 차단된 것으로 표시하며, 항목을 세션에 연결합니다. Didit은 세션에서 해당 유형의 가장 최근 기록을 읽습니다. 이전 기록의 값을 목록에 넣으려면 `reference_session_id` 없이 `value`로 추가합니다.
- **거래, 사용자 또는 기업에서**: 엔티티의 UUID와 함께 `reference_object_uuid`를 전달하고, 콘솔이 원본 기록으로 연결할 수 있도록 `metadata.reference_type`(`"transaction"`, `"vendor_user"` 또는 `"vendor_business"`)을 포함합니다.## 엔드포인트> [card] [모든 목록 조회](https://docs.didit.me/ko/management-api/lists/list.md)
>
> 애플리케이션의 모든 목록을 조회합니다.> [card] [목록 항목 조회](https://docs.didit.me/ko/management-api/lists/list-entries.md)
>
> 목록의 항목을 조회합니다.> [card] [항목 생성](https://docs.didit.me/ko/management-api/lists/create-entry.md)
>
> 차단 목록에 값을 추가합니다. 값, 세션 참조 또는 거래 참조로 추가할 수 있습니다.> [card] [항목 삭제](https://docs.didit.me/ko/management-api/lists/delete-entry.md)
>
> 항목을 삭제하고 해당 기반 엔티티의 차단을 해제합니다.> [card] [얼굴 업로드](https://docs.didit.me/ko/management-api/lists/upload-face.md)
>
> 얼굴 차단 목록에 얼굴 이미지를 직접 업로드합니다.


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