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

承認

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

ボディ

multipart/form-data
user_image
file
必須

検証するライブまたは候補の顔画像(例:セルフィー)。被写体の顔がはっきりと見え、十分に明るい正面向きの写真を1枚送信してください。使用可能な拡張子:tiff、jpg、jpeg、png、webp。最大アップロードサイズ:5 MB(これより大きいファイルは400で拒否されます)。画像は処理前に約0.5 MBへ自動的に圧縮されるため、解像度を非常に高くしても精度は向上しません。

ref_image
file
必須

比較対象となる基準の顔画像(例: 身分証明書の顔写真や以前に登録した写真)。形式とサイズの制限はuser_imageと同じです。

face_match_score_decline_threshold
number<float>
デフォルト:30

レスポンスのstatusを決定する類似度のしきい値(0〜100)。算出されたスコアがこの値以下の場合、statusはDeclinedとなり、LOW_FACE_MATCH_SIMILARITY警告が追加されます。この値を厳密に上回るスコアではApprovedが返されます。デフォルトの30は緩い設定です。より厳格な検証を行うには値を引き上げてください(例: 50〜60)。0〜100の範囲外の値では400が返されます。

必須範囲: 0 <= x <= 100
例:

50

rotate_image
boolean
デフォルト:false

trueの場合、入力画像を90度単位(0、90、180、270)で試し、最も良好に顔を検出できる向きを使用します。EXIFの向き情報がないモバイル撮影画像に便利です。レイテンシが増加するため、画像が正立していることを保証できない場合にのみ有効にしてください。

例:

false

save_api_request
boolean
デフォルト:true

true(デフォルト)の場合、呼び出しはAPIタイプのセッションとして保存されます。このセッションはBusiness Consoleに表示され、返されたrequest_idを使ってGET /v3/session/{sessionId}/decision/で取得でき、status.updatedWebhookで通知されます。falseの場合、何も保存されず、request_idはレスポンスの照合専用の一時的なUUIDになります。

例:

true

vendor_data
string

任意の不透明な文字列(社内のユーザーID、メールアドレス、UUIDなど)です。保存されたセッションに格納され、レスポンスでそのまま返されます。API呼び出しを自社の記録と関連付けたり、後でセッションを絞り込んだりするために使用します。

例:

"user-123"

metadata
object

セッションとともに保存され(save_api_request=trueの場合)、レスポンスでそのまま返される任意のJSONオブジェクトです。マルチパートリクエストでは、JSONエンコードされた文字列フィールドとして送信してください(例: metadata={"flow":"login"})。オブジェクトとして解析されます。

例:

レスポンス

顔照合の計算が完了しました。face_match.scoreは0~100の浮動小数点数(小数点以下2桁)です。statusは、スコアがface_match_score_decline_thresholdを厳密に上回る場合はApproved、それ以外の場合は理由を説明する警告付きでDeclinedになります。類似度が低い場合やスコアを算出できないペアでも200が返されるため、HTTPコードだけでなくface_match.statusとface_match.warningsを確認してください。save_api_request=trueの場合、request_idは保存されたセッションIDです。

request_id
string<uuid>

save_api_request=trueの場合は保存されたセッションID(GET /v3/session/{sessionId}/decision/で使用可能)、それ以外の場合は一時的な相関UUIDです。

face_match
object
vendor_data
string | null

送信したvendor_dataのエコー、またはnull。

metadata
object | null

送信したmetadataオブジェクトのエコー、またはnull。

created_at
string<date-time>

レスポンスが生成された日時を示すISO 8601タイムスタンプ(UTC)。例: 2026-06-12T01:04:42.763237+00:00。

最終更新日 2026年11月1日