メインコンテンツへスキップ
POST
curl
リストにエントリを追加します。値はリストのエントリタイプに基づいて検証されます。
  • メール: 有効なメールアドレス
  • 電話番号: 有効な国際電話番号。E.164形式で保存されます(例: +14155552671)
  • ip_address: 有効なIPアドレスまたはCIDR範囲(例: 192.168.1.1、10.0.0.0/8)
  • device_fingerprint: 英字、数字、-、_、:、.からなる8文字以上の文字列。複数の異なるデバイスから報告されたフィンガープリントは、ブロックすると無関係な人まで却下してしまうため、ブロックリストには登録できません。
  • 国: 有効なISO 3166-1 alpha-3国コード(例: USA、GBR、ESP)。alpha-2コード(例: US)も受け付け、自動的にalpha-3に変換されます。
  • ユーザー、企業: ユーザーまたは企業のvendor_data
  • 顔、書類、wallet_address、bank_account、キー: 空でない任意の文字列
すべてのエントリ値は大文字と小文字を区別しません。送信した値は保存時に正規化され(電話番号はE.164形式に、国コードは大文字に、それ以外はすべて小文字に変換)、検証時には大文字と小文字を区別せずに照合されます。たとえばUser@Example.COMをブロックすると、user@example.comも検出されます。リストには同じ値を1つしか保持できません。すでにリストにある値を追加すると400が返されます。
顔の場合、画像しかないときは顔をアップロードを使用するか、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が返されます。

書類撮影時のセルフィーから取得する顔

ユーザーが書類を撮影している間、フロントカメラでユーザーのセルフィーを撮影できます(本人確認レポートのfront_image_camera_frontおよびback_image_camera_front画像)。この顔は、ライブネスの顔と同様に顔ブロックリストに追加できます。使用したい画像をface_image_sourceに指定してください。
  • エントリはシステムの顔ブロックリストにのみ作成され、valueは空のままにする必要があります。Diditはセッションのセルフィーから顔を取得します。
  • セルフィーには鮮明な顔が1つ写っている必要があります。そうでない場合、リクエストは400を返し、何も追加されません。
  • 各セルフィーは1回だけ追加できます。どのセルフィーから取得したかは、エントリのmetadata.face_image_sourceとmetadata.reference_node_idで確認できます。
  • 本人確認ステップが複数あるワークフローでは、reference_node_idでどのステップのセルフィーを使用するかを選択します。デフォルトでは、そのセルフィーを持つ最新の本人確認がDiditによって使用されます。
  • 以降、この顔は他のブロックリスト登録済みの顔と同様にチェックされます。すべての新しいセッションのライブネスセルフィー、およびすべての新しい書類撮影時のセルフィーと照合されます(FRONT_CAMERA_FACE_IN_BLOCKLISTを参照)。
  • エントリを削除すると、その顔はブロックリストから削除され、新しいセッションとは照合されなくなります。

同じタイプのレコードを複数持つセッション

セッションには、同じタイプのレコードを複数保持できます。たとえば、複数ステップのワークフローで取得した2つの電話番号などです。Diditは常に最新のレコードを読み取ります。reference_session_idと一緒にvalueを送信した場合、エントリには送信したvalueが保存されますが、紐付けは引き続き最新のレコードに対して行われ、システムブロックリストではそのレコードにフラグが付けられます。 それより前のレコードの値をリストに登録するには、reference_session_idを付けずにvalueのみで追加してください。

取引、ユーザー、企業の参照

取引またはベンダーユーザー、ベンダー企業のデータをブロックリストに登録する場合は、そのエンティティのUUIDをreference_object_uuidとして渡し、参照元のタイプをmetadataで指定します。
これにより、コンソールでブロックリストのエントリから元の取引、ユーザー、企業に移動できます。Diditは送信されたmetadataのキーを保存しますが、reference_image_urlとfront_image_urlは例外で、これらはDiditのみが設定します。セッションから読み取ったエントリでは、Diditが独自のキーを追加し、重複する場合はDiditのキーが優先されます。 システムのユーザーおよび企業ブロックリストでは、Diditは一致するユーザーまたは企業もBLOCKEDに設定します。対象は、vendor_dataがvalueと等しいもの、またはdidit_internal_idがreference_object_uuidと等しいものです。ユーザーブロックリストおよび企業ブロックリストを参照してください。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

パスパラメータ

list_uuid
string<uuid>
必須

追加先のリストのUUIDです。画像としてしか持っていない顔の場合は、代わりにUpload a face to a listを使用してください。

ボディ

application/json

value、reference_session_id、またはその両方を送信します。適用されるフィールドはリストのentry_typeによって異なります。

value
string

リストに追加する値。リストの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
string<uuid>

値の取得元となる、アプリケーションの個人または企業の認証セッション。Diditはそのセッションにおけるリストのエントリータイプ(face、document、phone、email、ip_addressまたはdevice_fingerprint)の最新レコードを読み取り、エントリーをセッションとそのレコードに紐付け、書類の場合はdisplay_labelとmetadataを入力します。device_fingerprintのブロックリストでは、デバイスクラスのフィンガープリントしか持たないセッション、または複数のデバイスで完了したセッションは拒否されます。正確なフィンガープリントをvalueとして送信してください。その他のエントリータイプの場合、またはセッションに該当するレコードがない場合は、valueも送信してください。その場合は送信したvalueが保存され、エントリーは引き続きセッションに紐付けられます。

reference_object_uuid
string<uuid>

エントリーがセッションに由来しない場合に、そのエントリーが表すレコードのUUID。取引のUUID、またはユーザーや企業のdidit_internal_idを指定します。metadata.reference_typeと組み合わせて使用します。reference_session_idがレコードを提供する場合は、セッションのレコードで置き換えられます。

face_image_source
enum<string>
デフォルト:liveness

reference_session_idを使用する顔リストの場合: セッションのどの画像から顔を取得するかを指定します。liveness(デフォルト)はライブネスのセルフィーです。front_image_camera_frontとback_image_camera_frontは、ユーザーが書類の表面または裏面を撮影している間にフロントカメラが撮影したセルフィーです。これらはシステムの顔ブロックリストでのみ、reference_session_idと空のvalueを指定した場合に受け付けられます。各セルフィーは1回のみ追加でき、鮮明な顔が1つ写っている必要があります。

利用可能なオプション:
liveness,
front_image_camera_front,
back_image_camera_front
reference_node_id
string | null

書類撮影のface_image_sourceを使用する場合:本人確認ノードが複数あるワークフローで、セルフィーを使用する本人確認ノード。デフォルトは、その画像を持つ最新の本人確認です。livenessとの併用は拒否されます。

Maximum string length: 100
display_label
string

人が読めるラベル。空の場合、Diditは可能であればセッションから生成します(例:保有者の氏名と書類番号)。

Maximum string length: 512
comment
string

掲載理由などの自由記述のメモ。

metadata
object

エントリとともに保存され、保存されたとおりに返される自由形式のJSON。コンソールが元のデータにリンクできるよう、reference_typeとreference_idを使用してください。reference_image_urlとfront_image_urlはDiditのみが設定するもので、送信しても破棄されます。セッションから読み込まれたエントリでは、Diditのキーがお客様のキーとマージされます。

レスポンス

エントリが作成されました。

リスト内の1つの値です。

uuid
string<uuid>
必須

エントリの識別子。「リストエントリの削除」でentry_uuidとして使用します。

value
string
必須

登録された値です。E.164形式の電話番号、メールアドレス、書類番号、IPアドレスまたはCIDR範囲、デバイスフィンガープリント、ウォレットアドレス、銀行口座、ISO 3166-1 alpha-3の国コード、vendor_data、keyリスト上の任意の文字列、または顔リスト上の保存された顔のUUIDのいずれかです。送信した値は、電話番号と国コードを除き小文字で保存されます。照合では大文字と小文字は区別されません。

display_label
string | null
必須

人が読めるラベル。送信しない場合、セッションから取得したエントリについてはDiditが自動で設定します(例:保有者の氏名と書類番号)。

Maximum string length: 512
comment
string
必須

自由記述のメモ。未設定の場合は空文字列です。

added_by
string | null
必須

エントリを追加した主体:api(APIキー)、コンソールユーザーのメールアドレスまたはconsole、systemまたはmigration(Diditが作成したエントリ)、あるいはrule(取引ルールまたはモニタリングルールのアクション)。

reference_session_id
string<uuid> | null
必須

エントリーの取得元となった認証セッション。エントリーが値で追加された場合はnullです。

reference_session_number
integer | null
必須

そのセッションのアプリケーション単位の番号。コンソールに表示される番号と同じです。

reference_session_type
enum<string> | null
必須

個人の認証セッションの場合はkyc、企業の認証セッションの場合はkyb、セッションがない場合はnull。

利用可能なオプション:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
必須

エントリが表すレコード: セッションから読み取った顔、書類、電話番号またはメールアドレスのレコード、Upload a face to a listで作成された顔、または送信したUUID(例: 取引のUUIDやユーザーのdidit_internal_id)。

metadata
object | null
必須

追加コンテキストです。Diditが設定するキー(ここに記載)と、エントリー作成時に送信したmetadataをマージし、保存されたとおりに返します。ない場合はnullです。

created_at
string<date-time>
必須

エントリーが追加された日時。

最終更新日 2026年11月1日