> ## 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 のブロックリスト、許可リスト、カスタムリストを管理し、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を使用すると、アプリケーション用のタイプ別リストを管理できます。システムブロックリストは自動的に作成され、認証時および取引スクリーニング時にチェックされます。また、ワークフロー条件で使用する許可リストやカスタムリストを作成することもできます。## 概念| タイプ | 説明 |
| - | - |
| **ブロックリスト** | システムが作成し、エントリタイプごとに1つ存在します。ブロックリストに含まれる項目は、認証時または取引スクリーニング時に自動的に却下されます。 |
| **許可リスト** | ユーザーが作成します。ワークフローの条件で使用されるほか、信頼できる一致項目に対する重複・再利用アクションを抑制するために使用されます。 |
| **カスタム** | ユーザーが作成します。ワークフローの分岐、モニタリングルール、手動レビューに使用できる柔軟なリストです。 |## エントリタイプ| エントリタイプ | チェックされるタイミング | 一致した場合 |
| - | - | - |
| `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個のシステムブロックリスト（サポートされているエントリタイプごとに1つ）と、システムの**High Risk Countries**リストが自動的に用意されます。これらは削除することも名前を変更することもできません。エントリはAPIまたはコンソールから追加できます。## トレーサビリティすべてのブロックリストエントリは、そのソースエンティティに紐付けることができるため、リストから元のレコードに移動できます。- **セッションから**: [エントリを作成](https://docs.didit.me/ja/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/ja/management-api/lists/list.md)
>
> アプリケーションのすべてのリストを取得します。> [card] [エントリを一覧表示](https://docs.didit.me/ja/management-api/lists/list-entries.md)
>
> リスト内のエントリを取得します。> [card] [エントリを作成](https://docs.didit.me/ja/management-api/lists/create-entry.md)
>
> 値、セッション参照、または取引参照を指定して、ブロックリストに値を追加します。> [card] [エントリを削除](https://docs.didit.me/ja/management-api/lists/delete-entry.md)
>
> エントリを削除し、対象のエンティティのブロックを解除します。> [card] [顔をアップロード](https://docs.didit.me/ja/management-api/lists/upload-face.md)
>
> 顔画像を顔のブロックリストに直接アップロードします。


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