メインコンテンツへスキップ
POST
curl
Base64でエンコードした顔画像を、顔のブロックリストまたは許可リストにアップロードします。Diditは画像内の顔を検出して最も大きい顔を残し、画像とその顔の切り抜きを保存したうえで、新しいセッションとの照合に使う顔の生体認証テンプレートを算出します。新しいエントリーのvalueは、その顔のUUIDです。 entry_type: faceかつlist_type: blocklistまたはlist_type: allowlistのリストでのみ利用できます。
既存のセッションから顔をブロックリストまたは許可リストに登録する場合は、代わりにreference_session_idを指定してエントリーを作成を使用してください。エントリーはそのセッションに紐付けられます。
画像には顔がはっきりと写っている必要があり、デコード後のサイズは2 MB以下でなければなりません。顔が検出されない場合、リクエストは400を返し、エントリーは作成されません。顔分析が一時的に利用できない場合は503を返します。時間をおいて再試行してください。
リストから顔を削除するには、そのエントリーを削除します。削除すると、その顔は新しいセッションと照合されなくなります。

承認

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>
必須

entry_type: faceで、list_type: blocklistまたはallowlistであるリストのUUIDです。

ボディ

application/json
image
string<byte>
必須

Base64エンコードされたJPEGまたはPNG画像で、デコード後のサイズが最大2MB、かつ顔がはっきりと写っているものです。data:image/...;base64,プレフィックスを付けず、Base64文字列のみを送信してください。

comment
string
デフォルト:""

登録理由など、任意の自由記述のメモです。

レスポンス

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

リスト内の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日