比較対象の顔画像に複数の顔が含まれる場合に、 2 つの画像に含まれる顔の各グループの類似度スコアを返します。
顔画像は、以下の要件を満たすものとします。
JPG (JPEG)、BMP、PNG、GIF、TIFF のいずれかの形式
幅と高さは 8 px 以上 5,000 px 以下
ファイルサイズは 5 MB 以下
POST
例:
first_image_file に相当する図 A に 2 つの顔 (a1、a2) が含まれていて、second_image_file に相当する 図 B にも 2 つの顔 (b1、b2) が含まれているとします。a1b1 などの値は、図 A に含まれる顔 a1 と図 B に含まれる顔 b1 の比較スコアを表します。
顔比較スコアの閾値とエラー率との対応関係:
推奨閾値: 0.7 以上
システムレスポンスコードの説明
可能性のある http ステータスコード:
フィールド
型
必須
説明
first_encrypted_image
String
Yes
暗号化された画像 1。暗号化方法の参照: 個人データの暗号化
second_encrypted_image
String
Yes
暗号化された画像 2。暗号化方法の参照: 個人データの暗号化
auto_rotate
boolean
No
デフォルト値は false で、画像が回転していないことを示します。値が true の場合、画像は自動的に回転されます。
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード: 1000
scores
array
画像の各グループの顔のスコアの比較。推奨閾値: 0.7〜0.8
face_rects
hash
各画像の顔の顔枠
request_id
string
リクエスト番号
閾値
0.4
0.5
0.6
0.7
0.8
0.9
エラー率
1/10
1/100
1/1000
1/10,000
1/100,000
1/1,000,000
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード
message
string
エラーメッセージ
コード
フィールドの値
説明
1200
invalid argument
無効な入力パラメーター
2003
invalid image size
画像サイズが要件を満たしていません
2004
invalid content length
画像コンテンツの長さが要件を満たしていません
2005
invalid image type
画像タイプが要件を満たしていません
2006
corrupted image error
画像が破損しています
4000
detection failed
特徴の抽出に失敗しました。画像に顔が検出されませんでした
ステータスコード
ステータスフィールド
400
BAD_REQUEST
404
NOT_FOUND
411
LENGTH_REQUIRED
413
PAYLOAD_TOO_LARGE
500
INTERNAL_ERROR
インターフェースを介してアップロードされた顔画像と生体認証データを比較して、画像内の顔が同一人物のものであるかどうかを判断します。
画像は、以下の要件を満たすものとします。
JPG (JPEG)、BMP、PNG、GIF、TIFF のいずれかの形式
幅と高さは 8 px 以上 5,000 px 以下
ファイルサイズは 5 MB 以下
POST
顔比較スコアの閾値とエラー率との対応関係:
推奨閾値: 0.7 以上
システムレスポンスコードの説明
可能性のある http ステータスコード:
このAPIは、サイレント生体認証結果と自撮りの顔写真を比較に利用されています。
POST
一般的なビデオフォーマットはサポートされています。例えば: .mp4, .avi, .flv, .wmv, .mov, .rm
顔画像は、以下の要件を満たすものとします。
JPG (JPEG)、BMP、PNG、GIF、TIFF のいずれかの形式
幅と高さは 8 px 以上 5,000 px 以下
ファイルサイズは 5 MB 以下
ここで、liveness_status
の結果は以下のようになる:
顔比較スコアの閾値とエラー率との対応関係:
推奨閾値: 0.7 以上
システムレスポンスコードの説明
可能性のある http ステータスコード:
フィールド
型
必須
説明
liveness_file
File
Yes
インタラクティブ・ライブネスまたはサイレント・ライブネスSDKによる検出に成功した後に返された暗号化されたバイナリ・ストリーム・ファイル(i.e. protobufData)です。別途の暗号化を必要とせずに既に暗号化されています。
encrypted_image
String
Yes
暗号化された画像 。暗号化方法の参照: 個人データの暗号化
auto_rotate
boolean
No
デフォルト値は false で、画像が回転していないことを示します。値が true の場合、画像は自動的に回転されます。
check_quality
boolean
No
デフォルト値が false の場合は品質チェックを行わず、true の場合は画像の品質チェックを行います。
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード: 1000
verification_score
float
顔照合スコア、値0~1、値が高いほど同一人物である可能性が高いことです。
閾値
0.4
0.5
0.6
0.7
0.8
0.9
エラー率
1/10
1/100
1/1000
1/10,000
1/100,000
1/1,000,000
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード
message
string
エラーメッセージ
コード
フィールドの値
説明
1200
invalid argument
無効な入力パラメーター
2003
invalid image size
画像サイズが要件を満たしていません
2004
invalid content length
画像コンテンツの長さが要件を満たしていません
2005
invalid image type
画像タイプが要件を満たしていません
2006
corrupted image error
画像が破損しています
4000
detection failed
特徴の抽出に失敗しました。画像に顔が検出されませんでした
4004
face occlusion
顔は検出されたが、目、鼻、口が部分的に見えないです
ステータスコード
ステータスフィールド
400
BAD_REQUEST
404
NOT_FOUND
411
LENGTH_REQUIRED
413
PAYLOAD_TOO_LARGE
500
INTERNAL_ERROR
フィールド
型
必須
説明
first_encrypted_image
String
Yes
暗号化された画像 1。暗号化方法の参照: 個人データの暗号化
second_encrypted_image
String
Yes
暗号化された画像 2。暗号化方法の参照: 個人データの暗号化
auto_rotate
boolean
No
デフォルト値は false で、画像が回転していないことを示します。値が true の場合、画像は自動的に回転されます。
check_quality
boolean
No
デフォルト値は false で、画質テストは行われません。値がtrueの場合、画質のテストが行われます。
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード: 1000
verification_score
float
顔比較スコア、範囲: 0~1 。値が大きいほど、2 つの顔が同じ人物のものである確率が高くなります。
閾値
0.4
0.5
0.6
0.7
0.8
0.9
エラー率
1/10
1/100
1/1000
1/10,000
1/100,000
1/1,000,000
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード
message
string
エラーメッセージ
コード
フィールドの値
説明
1200
invalid argument
無効な入力パラメーター
2003
invalid image size
画像サイズが要件を満たしていません
2004
invalid content length
画像ボリュームが要件を満たしていません
2005
invalid image type
画像タイプが要件を満たしていません
2006
corrupted image error
画像が破損しています
4000
detection failed
特徴の抽出に失敗しました。画像に顔が検出されませんでした。
4004
face occlusion
顔は検出されたが、目、鼻、口で部分的に見えなくなっています。
ステータスコード
ステータスフィールド
400
BAD_REQUEST
404
NOT_FOUND
411
LENGTH_REQUIRED
413
PAYLOAD_TOO_LARGE
500
INTERNAL_ERROR
フィールド
型
必須
説明
encrypted_video
String
Yes
暗号化された動画。暗号化方法の参照: 個人データの暗号化
encrypted_image
String
Yes
暗号化された画像 。暗号化方法の参照: 個人データの暗号化
auto_rotate
boolean
No
デフォルト値は false で、画像が回転していないことを示します。値が true の場合、画像は自動的に回転されます
check_quality
boolean
No
デフォルト値が false の場合は品質チェックを行わず、true の場合は画像の品質チェックを行います
return_image
boolean
No
選出されたフレーム画像と選出されたフレーム画像のタイムスタンプを返すかどうか。 デフォルト値は false で、値が true かつ生体認証が通過した場合に image_timestamp
, base64_image
フィールドが返されます
return_face_image
boolean
No
選出されたフレーム画像の顔のクロップを返すかどうか。 デフォルト値は false で、値が true かつ生体認証が通過した場合に base64_face_image
フィールドは返されます
return_status
boolean
No
エラーステータスの説明を返すかどうかを指定します。デフォルトはfalseです; liveness_status
フィールドは値がtrueの場合にのみ返されます
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード: 1000
passed
boolean
生体認証に通過したかどうか
liveness_score
float
サイレント生体認証のスコア(参考までに、結果はpassedフィールドを使用してください)
liveness_status
string
サイレントライブネス検出のエラー状態を記述します。このフィールドは、return_status=true の時に返されます
verification_score
float
顔照合スコア、おすすめの閾値: > 0.7。このフィールドはpassed=trueの場合に返されます
image_timestamp
float
選出されたフレームのタイムスタンプを秒単位で表し、passed=true、return_image=trueの場合に返されます
base64_image
string
選出されたフレーム画像、passed=true、return_image=trueの場合は該当フィールドを返します
base64_face_image
string
選出された顔写真の切り抜き、passed=true、return_face_image=trueの場合に返されます
ステータス
説明
ok
サイレント生体認証は合格した: 動画の中の人は実在する
hack
サイレント生体認証は合格してない、理由: 捏造した顔 (例えば, ビデオで撮影された顔)
short_time
サイレント生体認証は合格してない、理由: ビデオの持続時間は2s未満
no_face_detected
サイレント生体認証は合格してない、理由: 映像から顔は検出されません
loss_tracking
サイレント生体認証は合格してない、理由: 途中で顔がフレームアウト
face_changed
サイレント生体認証は合格してない、理由: 動画の途中で顔が入れ替わっていました
face_occlusion
サイレント生体認証は合格してない、理由: 一定期間顔が見えなくなる
閾値
0.4
0.5
0.6
0.7
0.8
0.9
エラー率
1/10
1/100
1/1000
1/10,000
1/100,000
1/1,000,000
フィールド
型
説明
request_id
string
このリクエストのID
code
int
システムレスポンスコード
message
string
エラーメッセージ
コード
フィールドの値
説明
1200
invalid argument
無効な入力パラメーター
2003
invalid image size
画像サイズが要件を満たしていません
2004
invalid content length
画像コンテンツの長さが要件を満たしていません
2005
invalid image type
画像タイプが要件を満たしていません
2006
corrupted image error
画像が破損しています
4000
detection failed
特徴の抽出に失敗しました。画像に顔が検出されませんでした
4004
face occlusion
顔は検出されるが、目、鼻、口が部分的に見えないです
4007
liveness silent check failed
サイレント生体認証失敗
ステータスコード
ステータスフィールド
400
BAD_REQUEST
404
NOT_FOUND
411
LENGTH_REQUIRED
413
PAYLOAD_TOO_LARGE
500
INTERNAL_ERROR