メインコンテンツへスキップ
POST
curl

概要

他のプロバイダーからユーザーをインポートする際に、各人物について信頼できる顔画像をすでに保有している場合は、このエンドポイントを使用します。ユーザーは引き続きvendor_dataをキーとして管理されますが、このプロフィール添付用エンドポイントでは対象ユーザーを一意に特定できるようdidit_internal_idを使用します。
これはリストへの顔画像アップロードとは異なります。プロフィールへのアップロードは、証拠、重複検知、顔検索のために顔画像をユーザーに添付するものです。リストへのアップロードは、顔タイプのブロックリストに顔画像を追加し、今後のマッチングセッションを却下できるようにするものです。

エンドポイント

POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/

移行フロー

1

ユーザーを作成または検索する

新しいプロフィールの場合はPOST /v3/users/create/を、既存のプロフィールの場合はGET /v3/users/{vendor_data}/を呼び出します。
2

didit_internal_idを保存する

ユーザーのレスポンスにはdidit_internal_idが含まれます。データベースでは引き続きvendor_dataを使用し、didit_internal_idはプロフィール添付用エンドポイントでのみ使用してください。
3

顔画像をアップロードする

imageフィールドにraw base64形式の画像を送信します。バックエンドは保存前に、画像のデコード、画像サイズ、顔検出を検証します。

例

リクエストボディ

レスポンス

バリデーションと制限

  • 手動でアップロードできる顔画像は、ユーザー1人あたり最大5件です。
  • デコード後の画像サイズは最大2MBです。
  • 画像は有効なbase64であり、画像としてデコードできる必要があります。
  • 画像には検出可能な顔が含まれている必要があります。可能な限り、正面を向いた明るい顔の切り抜き画像を使用してください。
  • アップロードされた顔画像は、今後の重複検知と顔検索のためにインデックス化されます。
  • アップロードされた顔画像が自動的にブロックリストに登録されることはありません。

アップロードした顔画像の一覧表示または削除

プロフィールの顔画像を一覧表示する:
プロフィールの顔画像を1件削除する:

権限

同じアプリケーションのAPIキーを使用してください。キーは、対象ユーザープロフィールの管理を許可されているアプリケーションに属している必要があります。

エラーケース

  • 400:base64が無効、画像が無効、検出可能な顔がない、画像が2MBを超えている、またはユーザーにすでに5件の顔画像がアップロードされている。
  • 401:認証情報がない、または無効。
  • 403:APIキーは有効だが、このユーザーのプロフィールを管理する権限がない。
  • 404:アプリケーション内に、そのdidit_internal_idのユーザーが存在しない。
  • 429:レート制限中。Retry-Afterに従って間隔を空けてください。

関連項目

承認

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

パスパラメータ

organization_id
string<uuid>
必須

アプリケーションを所有する組織のUUIDです。

application_id
string<uuid>
必須

ユーザープロファイルを所有するアプリケーションのUUID。

didit_internal_id
string<uuid>
必須

Diditの内部ユーザーUUIDです。GET /v3/users/{vendor_data}/およびPOST /v3/users/create/がdidit_internal_idとして返します。

ボディ

application/json
image
string<byte>
必須

Base64エンコードされたJPGまたはPNGの生の顔画像。data:image/...;base64,プレフィックスは含めないでください。デコード後の最大サイズは2MBです。

comment
string
デフォルト:""

アップロードした顔に対する、オペレーターに表示される任意のメモです。

レスポンス

顔がアップロードされ、ユーザープロファイルに紐付けられました。

uuid
string<uuid>
必須

アップロードされたユーザー顔レコードのUUID。

image_url
string<uri> | null
必須

アップロードされた顔画像の署名付きURL。

comment
string | null
必須

顔のアップロード時に指定されたコメント。

uploaded_by
string | null
必須

利用可能な場合、アップロードしたユーザーのメールアドレスまたはアクター識別子。

created_at
string<date-time>
必須

アップロードのタイムスタンプ。

最終更新日 2026年11月1日