> ## 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のブロックリスト、許可リスト、カスタムリストに、顔・書類・IP・ウォレット・メール・電話番号のエントリーを追加します。コンプライアンスと不正対策をプログラムで管理できます。 リストエントリ作成APIプロンプト プロンプトをクリップボードにコピー \

\`Add an entry to a Didit list (blocklist, allowlist, or custom) through the Management API.

Endpoint:
POST 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: write.

Goal:
\- Insert a single entry into a list. Three add modes are supported:
1\. By value: pass value matching the list's entry_type.
2\. From a verification session: pass reference_session_id and Didit reads the value from the session's most recent record of the list's entry_type (face, document, phone, email, ip_address, device_fingerprint) and links the entry to the session.
3\. With a source reference: pass value plus reference_object_uuid and metadata.reference_type so the console links the entry back to the transaction, user or business it came from.

Path parameter:
\- list_uuid: list UUID from GET /v3/lists/. For a face without a session, use POST /v3/lists/{list_uuid}/entries/face-upload/ instead.

Request body (application/json):
\{
"value": "string",                  // required unless reference_session_id is sent
"reference_session_id": "uuid",     // optional: read the value from this session of my application
"reference_object_uuid": "uuid",    // optional: transaction UUID, or didit_internal_id of a user or business
"face_image_source": "liveness" | "front_image_camera_front" | "back_image_camera_front", // optional, system face blocklist + reference_session_id only; default liveness
"reference_node_id": "string",      // optional, with a document-capture face_image_source: which ID verification node's selfie to use
"display_label": "string",          // optional, at most 512 characters
"comment": "string",                // optional, reason or note
"metadata": {                       // optional, free-form; reference_image_url and front_image_url are ignored
"reference_type": "transaction" | "vendor_user" | "vendor_business",
"reference_id": "uuid"
}
}

Value validation by entry_type:
\- email: valid email address.
\- phone: valid international phone number (stored in E.164).
\- ip_address: IP address 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-2 or alpha-3 (stored as alpha-3).
\- user, business: the vendor_data to block.
\- face, document, wallet_address, bank_account, key: any non-empty string.
Values are case-insensitive: country codes are stored in upper case, phone numbers in E.164, everything else in lower case.
A list holds each value once: adding a value that is already there returns 400.

Adding from a session, what Didit does:
\- Looks up the session (it must belong to the same application).
\- Reads the value from the session's most recent record of the list's entry_type:
\- face: the liveness face (value is the face UUID). With face_image_source = front_image_camera_front / back_image_camera_front, the face from the selfie the front camera took while the user photographed the front / back of their document instead (system face blocklist only, leave value empty).
\- document: the document number; full_name, issuing_state, document_type, region and document_number go into metadata.
\- phone / email: the phone number / email address.
\- ip_address: the session's IP address.
\- device_fingerprint: a fingerprint that identifies one device. On a blocklist, Didit refuses a session that only has a device-class fingerprint or was completed on more than one device; pass the exact fingerprint as value in that case.
\- Links the entry to the session (reference_session_id) and to that record (reference_object_uuid).
\- If I also send value, Didit stores my value but still links the most recent record. To list a value from an earlier record, add it by value without reference_session_id.

Example calls:
\# By value
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "+14155552671", "comment": "Reported fraud"}'

\# From a session
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777"}'

\# The face from the selfie taken during document capture (system face blocklist)
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front"}'

\# From a transaction
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": {"reference_type": "transaction"}}'

Failure modes:
\- 400: value fails the entry_type validator or is already in the list, neither value nor reference_session_id was sent, reference_session_id is not a session of this application, or the session has no data of the list's entry_type.
\- 400 (face_image_source): the list is not the system face blocklist, value was sent, the session has no image for that source, no clear face was found in that selfie, or that selfie is already in the blocklist.
\- 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: write.
\- 404: list not found in this application ({ "detail": "List not found." }).
\- 503 (face_image_source): face analysis is temporarily unavailable; nothing was added, retry later.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- System face, document, phone and email blocklists: a record read from a session is flagged as blocklisted at once, and new sessions that match it are declined.
\- System user and business blocklists: users or businesses of the application whose vendor_data equals value (or whose UUID equals reference_object_uuid) are set to BLOCKED.
\- Sessions and transactions that already finished are not changed.

For the full integration shape, see /integration/integration-prompt.`

\
貼り付け先 リストにエントリを追加します。値はリストのエントリタイプに基づいて検証されます。* **メール**: 有効なメールアドレス * **電話番号**: 有効な国際電話番号。E.164形式で保存されます(例: `+14155552671`) * **ip\_address**: 有効なIPアドレスまたはCIDR範囲(例: `192.168.1.1`、`10.0.0.0/8`) * **device\_fingerprint**: 英字、数字、`-`、`_`、`:`、`.`からなる8文字以上の文字列。複数の異なるデバイスから報告されたフィンガープリントは、ブロックすると無関係な人まで却下してしまうため、ブロックリストには登録できません。 * **国**: 有効な[ISO 3166-1 alpha-3国コード](https://docs.didit.me/ja/core-technology/id-verification/supported-documents-id-verification.md)(例: `USA`、`GBR`、`ESP`)。alpha-2コード(例: `US`)も受け付け、自動的にalpha-3に変換されます。 * **ユーザー**、**企業**: ユーザーまたは企業の`vendor_data` * **顔**、**書類**、**wallet\_address**、**bank\_account**、**キー**: 空でない任意の文字列> [!NOTE] > > すべてのエントリ値は**大文字と小文字を区別しません**。送信した値は保存時に正規化され(電話番号はE.164形式に、国コードは大文字に、それ以外はすべて小文字に変換)、検証時には大文字と小文字を区別せずに照合されます。たとえば`User@Example.COM`をブロックすると、`user@example.com`も検出されます。リストには同じ値を1つしか保持できません。すでにリストにある値を追加すると`400`が返されます。顔の場合、画像しかないときは[顔をアップロード](https://docs.didit.me/ja/management-api/lists/upload-face.md)を使用するか、`reference_session_id`を送信して既存セッションの顔を取得してください。顔のエントリには照合対象となる保存済みの顔が必要ですが、入力した`value`ではそれを用意できません。## セッションからの追加`reference_session_id`を指定すると、Diditは次の処理を行います。1) セッションを検索します(同じアプリケーションに属している必要があります) 2) リストのエントリタイプに対応する、セッションの**最新の**レコードから値を読み取ります。 * **顔**: ライブネスセルフィーの顔。`value`は顔のUUIDです * **書類**: 書類番号。氏名、発行州、書類の種類、地域、書類番号は`metadata`に保存され、`display_label`のデフォルトは所持者の氏名と書類番号です * **電話番号**: 電話番号 * **メール**: メールアドレス * **ip\_address**: セッションのIPアドレス * **device\_fingerprint**: 1台のデバイスを識別するフィンガープリント。認証ステップを完了したデバイスが優先されます。ブロックリストでは、デバイスクラスのフィンガープリントしか持たないセッションや、複数のデバイスで完了したセッションをDiditは受け付けません。その場合は、正確なフィンガープリントを`value`として送信してください。 3) 追跡できるように、エントリをセッション(`reference_session_id`)およびレコード(`reference_object_uuid`)に紐付けますシステムの顔、書類、電話番号、メールのブロックリストでは、そのレコードにもブロックリスト登録済みのフラグが付けられ、一致する新しいセッションは却下されます。その他のエントリタイプでは、`value`も送信してください。セッションが見つからない場合や、要求したエントリタイプのデータがセッションに含まれていない場合は`400`が返されます。### 書類撮影時のセルフィーから取得する顔ユーザーが書類を撮影している間、フロントカメラでユーザーのセルフィーを撮影できます([本人確認レポート](https://docs.didit.me/ja/core-technology/id-verification/report-id-verification.md)の`front_image_camera_front`および`back_image_camera_front`画像)。この顔は、ライブネスの顔と同様に顔ブロックリストに追加できます。使用したい画像を`face_image_source`に指定してください。```json theme={null} { "reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front" } ```- エントリはシステムの**顔ブロックリスト**にのみ作成され、`value`は空のままにする必要があります。Diditはセッションのセルフィーから顔を取得します。 - セルフィーには鮮明な顔が1つ写っている必要があります。そうでない場合、リクエストは`400`を返し、何も追加されません。 - 各セルフィーは1回だけ追加できます。どのセルフィーから取得したかは、エントリの`metadata.face_image_source`と`metadata.reference_node_id`で確認できます。 - 本人確認ステップが複数あるワークフローでは、`reference_node_id`でどのステップのセルフィーを使用するかを選択します。デフォルトでは、そのセルフィーを持つ最新の本人確認がDiditによって使用されます。 - 以降、この顔は他のブロックリスト登録済みの顔と同様にチェックされます。すべての新しいセッションのライブネスセルフィー、およびすべての新しい書類撮影時のセルフィーと照合されます([`FRONT_CAMERA_FACE_IN_BLOCKLIST`](https://docs.didit.me/ja/core-technology/id-verification/warnings-id-verification)を参照)。 - エントリを削除すると、その顔はブロックリストから削除され、新しいセッションとは照合されなくなります。### 同じタイプのレコードを複数持つセッションセッションには、同じタイプのレコードを複数保持できます。たとえば、複数ステップのワークフローで取得した2つの電話番号などです。Diditは常に**最新の**レコードを読み取ります。`reference_session_id`と一緒に`value`を送信した場合、エントリには送信した`value`が保存されますが、紐付けは引き続き最新のレコードに対して行われ、システムブロックリストではそのレコードにフラグが付けられます。それより前のレコードの値をリストに登録するには、`reference_session_id`を付けずに`value`のみで追加してください。```json theme={null} { "value": "+34612345678", "comment": "First phone number of session 42" } ```## 取引、ユーザー、企業の参照取引またはベンダーユーザー、ベンダー企業のデータをブロックリストに登録する場合は、そのエンティティのUUIDを`reference_object_uuid`として渡し、参照元のタイプを`metadata`で指定します。```json theme={null} { "value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": { "reference_type": "transaction", "reference_id": "55555555-6666-7777-8888-999999999999" } } ```これにより、コンソールでブロックリストのエントリから元の取引、ユーザー、企業に移動できます。Diditは送信された`metadata`のキーを保存しますが、`reference_image_url`と`front_image_url`は例外で、これらはDiditのみが設定します。セッションから読み取ったエントリでは、Diditが独自のキーを追加し、重複する場合はDiditのキーが優先されます。| 参照元エンティティ | `reference_object_uuid` | `metadata.reference_type` | | - | - | - | | 検証セッション | Diditが設定（顔、書類、電話番号、メールのレコード） | 不要。`reference_session_id`を使用 | | 取引 | 取引のUUID | `"transaction"` | | ベンダーユーザー | `didit_internal_id` | `"vendor_user"` | | ベンダー企業 | `didit_internal_id` | `"vendor_business"` |システムの**ユーザー**および**企業**ブロックリストでは、Diditは一致するユーザーまたは企業も`BLOCKED`に設定します。対象は、`vendor_data`が`value`と等しいもの、または`didit_internal_id`が`reference_object_uuid`と等しいものです。[ユーザーブロックリスト](https://docs.didit.me/ja/entities/users/blocklist.md)および[企業ブロックリスト](https://docs.didit.me/ja/entities/businesses/blocklist.md)を参照してください。 ## OpenAPI ````yaml ja/openapi-25.json POST /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/: post: tags: - Lists summary: リストエントリを作成 description: >- リストにエントリを1件追加します。方法は3つあります。`value`で指定する方法、`reference_session_id`で検証セッションから追加する方法（Diditはリストのエントリ種別に対応するセッションの最新レコードから値を読み取り、エントリをそのレコードに紐付けます）、または`value`に加えて取引、ユーザー、企業を参照する`reference_object_uuid`と`metadata.reference_type`を指定する方法です。システムの顔、書類、電話番号、メールアドレスのブロックリストでは、セッションから読み取ったレコードもブロックリスト登録済みとしてフラグ付けされるため、一致する新規セッションは却下されます。システムのユーザーおよび企業のブロックリストでは、一致するユーザーまたは企業が`BLOCKED`に設定されます。すでに完了したセッションと取引は変更されません。スコープ付きAPIキーには`workflows: write`が必要です。各方法については[リストエントリの作成](https://docs.didit.me/ja/management-api/lists/create-entry)を参照してください。 operationId: create_list_entry parameters: - name: list_uuid in: path required: true description: >- 追加先のリストのUUIDです。画像としてしか持っていない顔の場合は、代わりにUpload a face to a listを使用してください。 schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 requestBody: required: true content: application/json: schema: type: object description: >- `value`、`reference_session_id`、またはその両方を送信します。適用されるフィールドはリストの`entry_type`によって異なります。 properties: value: type: string description: >- リストに追加する値。リストの`entry_type`に照らして検証されます。`email`は有効なメールアドレス、`phone`は有効な国際電話番号（E.164形式で保存）、`ip_address`はIPアドレスまたはCIDR範囲（例: `10.0.0.0/8`）、`device_fingerprint`は英字、数字、`-`、`_`、`:`、`.`からなる8文字以上（複数の異なるデバイスから報告されたフィンガープリントはブロックリストで拒否されます）、`country`はISO 3166-1 alpha-2またはalpha-3コード（alpha-3で保存）、`user`と`business`は`vendor_data`、その他のタイプは空でない文字列です。電話番号と国コードを除き小文字で保存され、リスト内で各値は1回のみ保持されます（大文字と小文字は区別しません）。`reference_session_id`を送信しない限り必須です。書類撮影の`face_image_source`を指定する場合は空のままにする必要があります。 reference_session_id: type: string format: uuid description: >- 値の取得元となる、アプリケーションの個人または企業の認証セッション。Diditはそのセッションにおけるリストのエントリータイプ（`face`、`document`、`phone`、`email`、`ip_address`または`device_fingerprint`）の最新レコードを読み取り、エントリーをセッションとそのレコードに紐付け、書類の場合は`display_label`と`metadata`を入力します。`device_fingerprint`のブロックリストでは、デバイスクラスのフィンガープリントしか持たないセッション、または複数のデバイスで完了したセッションは拒否されます。正確なフィンガープリントを`value`として送信してください。その他のエントリータイプの場合、またはセッションに該当するレコードがない場合は、`value`も送信してください。その場合は送信した`value`が保存され、エントリーは引き続きセッションに紐付けられます。 reference_object_uuid: type: string format: uuid description: >- エントリーがセッションに由来しない場合に、そのエントリーが表すレコードのUUID。取引のUUID、またはユーザーや企業の`didit_internal_id`を指定します。`metadata.reference_type`と組み合わせて使用します。`reference_session_id`がレコードを提供する場合は、セッションのレコードで置き換えられます。 face_image_source: type: string enum: - liveness - front_image_camera_front - back_image_camera_front default: liveness description: >- `reference_session_id`を使用する顔リストの場合: セッションのどの画像から顔を取得するかを指定します。`liveness`（デフォルト）はライブネスのセルフィーです。`front_image_camera_front`と`back_image_camera_front`は、ユーザーが書類の表面または裏面を撮影している間にフロントカメラが撮影したセルフィーです。これらはシステムの顔ブロックリストでのみ、`reference_session_id`と空の`value`を指定した場合に受け付けられます。各セルフィーは1回のみ追加でき、鮮明な顔が1つ写っている必要があります。 reference_node_id: type: string nullable: true maxLength: 100 description: >- 書類撮影の`face_image_source`を使用する場合：本人確認ノードが複数あるワークフローで、セルフィーを使用する本人確認ノード。デフォルトは、その画像を持つ最新の本人確認です。`liveness`との併用は拒否されます。 display_label: type: string maxLength: 512 description: 人が読めるラベル。空の場合、Diditは可能であればセッションから生成します（例：保有者の氏名と書類番号）。 comment: type: string description: 掲載理由などの自由記述のメモ。 metadata: type: object additionalProperties: true description: >- エントリとともに保存され、保存されたとおりに返される自由形式のJSON。コンソールが元のデータにリンクできるよう、`reference_type`と`reference_id`を使用してください。`reference_image_url`と`front_image_url`はDiditのみが設定するもので、送信しても破棄されます。セッションから読み込まれたエントリでは、Diditのキーがお客様のキーとマージされます。 properties: reference_type: type: string enum: - transaction - vendor_user - vendor_business description: '`reference_object_uuid`が指す対象。' reference_id: type: string description: ソースレコードの識別子。 examples: By value: value: value: '+14155552671' comment: Reported fraud From a session: value: reference_session_id: 33333333-4444-5555-6666-777777777777 Face from a document-capture selfie: value: reference_session_id: 33333333-4444-5555-6666-777777777777 face_image_source: front_image_camera_front From a transaction: value: value: '0x52908400098527886E0F7030069857D2E4169EE7' reference_object_uuid: 55555555-6666-7777-8888-999999999999 comment: Linked to a chargeback metadata: reference_type: transaction reference_id: 55555555-6666-7777-8888-999999999999 Country: value: value: PRK comment: Sanctioned jurisdiction responses: '201': description: エントリが作成されました。 content: application/json: schema: $ref: '#/components/schemas/ComplianceListEntry' examples: By value: value: uuid: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee value: '+14155552671' display_label: '' comment: Reported fraud 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-12T10:04:51.220391Z' Document from a session: value: 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' From a transaction: value: uuid: dddddddd-eeee-ffff-0000-111111111111 value: '0x52908400098527886e0f7030069857d2e4169ee7' display_label: '' comment: Linked to a chargeback added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: 55555555-6666-7777-8888-999999999999 metadata: reference_type: transaction reference_id: 55555555-6666-7777-8888-999999999999 created_at: '2026-10-12T10:20:40.117062Z' '400': description: ボディが無効であるか、値がすでにリストに含まれているか、セッションから値を取得できません。 content: application/json: examples: Nothing to list: value: value: - >- Either 'value' or 'reference_session_id' must be provided. Duplicate value: value: value: - An entry with this value already exists in this list. Invalid phone: value: value: - >- Invalid phone number. Provide a valid international number (e.g. +1234567890). Invalid IP: value: value: - >- Invalid IP address or CIDR range (e.g. 192.168.1.1 or 10.0.0.0/24). Invalid country: value: value: - >- Invalid country code: XX. Provide a valid ISO 3166-1 alpha-2 or alpha-3 country code. Device-class fingerprint: value: value: - >- This value is a device-class fingerprint: several distinct devices have reported it, so blocklisting it would decline unrelated people. Block the user by document, face, email or phone instead. Unknown session: value: reference_session_id: - >- Session not found or does not belong to this application. No data in session: value: value: - >- Either provide a 'value' or ensure the session contains data for this entry type. Selfie on another list: value: face_image_source: - >- A document-capture selfie can only be added to the face blocklist. No clear face in selfie: value: face_image_source: - >- No clear face was found in this selfie, so it cannot be blocklisted. Selfie already listed: value: face_image_source: - This selfie is already in the blocklist. '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: write`がないか、許可リスト外の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 write access to workflows. '404': description: このUUIDのリストがAPIキーのアプリケーションに存在しないか、削除されています。 content: application/json: examples: Not found: value: detail: List not found. '429': $ref: '#/components/responses/RateLimitedWrite' '503': description: 書類撮影時のセルフィーの顔分析は一時的に利用できません。何も追加されていません。後で再試行してください。 content: application/json: examples: Unavailable: value: detail: Service temporarily unavailable. Please try again later. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"value": "+14155552671", "comment": "Reported fraud"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.lists.entries.create( "11111111-2222-3333-4444-555555555555", value="+14155552671", comment="Reported fraud", ) print(result) - lang: javascript label: Node.js source: >- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.lists.entries.create("11111111-2222-3333-4444-555555555555", { value: "+14155552671", comment: "Reported fraud", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesCreateParams{\n\tValue: didit.String(\"+14155552671\"),\n\tComment: didit.String(\"Reported fraud\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.ListsEntriesCreateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.lists().entries().create("11111111-2222-3333-4444-555555555555", ListsEntriesCreateParams.builder() .value("+14155552671") .comment("Reported fraud") .build()); System.out.println(result); - lang: php label: PHP source: >- lists->entries->create('11111111-2222-3333-4444-555555555555', [ 'value' => '+14155552671', 'comment' => 'Reported fraud', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.lists.entries.create( "11111111-2222-3333-4444-555555555555", value: "+14155552671", comment: "Reported fraud" ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Lists.Entries.CreateAsync("11111111-2222-3333-4444-555555555555", new ListsEntriesCreateParams { Value = "+14155552671", Comment = "Reported fraud", }); Console.WriteLine(JsonSerializer.Serialize(result)); 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: エントリーが追加された日時。 responses: RateLimitedWrite: description: APIキーあたり毎分300リクエストの共有書き込み制限を超えました。再試行する前に`Retry-After`に従ってください。 content: application/json: schema: type: object required: - detail properties: detail: type: string example: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. 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.