Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
SenseIDのAPI利用方法について記載されています。
本章では、必要に応じて参考にできるように、JCV顔認証サービスで提供されるすべてのAPIに関する手順について詳細に説明します。APIの説明には、機能の紹介、パラメーター、出力結果、エラーメッセージなどが含まれます。
インターフェースを介してアップロードされた2つの顔写真を比較して、2つの顔が同一人物のものかどうかを判断します。
写真の規格は、運用マニュアルの3章 写真と動画の規格をご参照ください。
POST
顔比較スコアのしきい値とエラー率との対応関係
推奨しきい値:0.7以上
比較対象の顔写真に複数の顔が含まれる場合、2つの写真に含まれる顔の各グループの類似度スコアを返します。
写真の規格は、運用マニュアルの3章 写真と動画の規格をご参照ください。
POST
例:
first_image_file に相当する図Aに2つの顔(a1、a2)が含まれていて、second_image_file に相当する図Bにも2つの顔(b1、b2)が含まれているとします。a1b1などの値は、図Aに含まれる顔a1と図Bに含まれる顔b1の比較スコアを表します。
顔比較スコアのしきい値とエラー率との対応関係
推奨しきい値:0.7以上
フィールド
型
必須
説明
first_encrypted_image
string
Yes
暗号化された写真1。暗号化方法の参照: 個人データの暗号化
second_encrypted_image
string
Yes
暗号化された写真2。暗号化方法の参照: 個人データの暗号化
auto_rotate
boolean
No
デフォルト値はfalseで、写真が回転していないことを示します。値がtrueの場合、写真は自動的に回転されます
check_quality
boolean
No
デフォルト値はfalseで、画質テストは行われません。値がtrueの場合、画質のテストが行われます
フィールド
型
説明
code
int
システムレスポンスコード:1000
verification_score
float
顔比較スコア、範囲:0〜1 。値が大きいほど、2つの顔が同じ人物のものである確率が高くなります
request_id
string
リクエストのID
閾値
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
フィールド
型
説明
code
int
システムレスポンスコード
message
string
エラーメッセージ
request_id
string
リクエストのID
コード
フィールドの値
説明
1200
invalid argument
無効な入力パラメーター
2003
invalid image size
写真サイズ(幅と高さのピクセル数)が要件を満たしていません
2004
invalid content length
写真のファイルサイズが要件を満たしていません
2005
invalid image type or corrupted
写真タイプが要件を満たしていません
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の場合、写真は自動的に回転されます
フィールド
型
説明
code
int
システムレスポンスコード:1000
scores
array
写真の各グループの顔のスコアの比較。推奨しきい値:0.7〜0.8
face_rects
hash
各写真の顔の顔枠
request_id
string
このリクエストのID
閾値
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
フィールド
型
説明
code
int
システムレスポンスコード
message
string
エラーメッセージ
request_id
string
リクエストのID
コード
フィールドの値
説明
1200
invalid argument
無効な入力パラメーター
2003
invalid image size
写真サイズ(幅と高さのピクセル数)が要件を満たしていません
2004
invalid content length
写真のファイルサイズが要件を満たしていません
2005
invalid image type or corrupted
写真タイプが要件を満たしていません
4000
detection failed
特徴の抽出に失敗しました。写真に顔が検出されませんでした
ステータスコード
ステータスフィールド
400
BAD_REQUEST
404
NOT_FOUND
411
LENGTH_REQUIRED
413
PAYLOAD_TOO_LARGE
500
INTERNAL_ERROR
日付
改訂内容
2021/08/20
1章 顔の比較と 2章 写真品質チェックシステムレスポンスコード2006を削除
1章 顔の比較と 2章 写真品質チェックシステムレスポンスコード2003と2004に説明文書を追加
1.4節と 3章 なりすまし防止発生しないliveness_status
をいくつ削除
2021/03/08
初版
ステータス | 説明 |
ok | サイレント生体認証は合格:動画の中の人は実在する |
hack | サイレント生体認証は不合格。理由:捏造した顔 (例えば, ビデオで撮影された顔) |
short_time | サイレント生体認証は不合格。理由:顔を含めるビデオの持続時間は2s未満 |
フィールド | 型 | 説明 |
code | int | システムレスポンスコード |
message | string | エラーメッセージ |
request_id | string | リクエストのID |
コード | フィールドの値 | 説明 |
1200 | invalid argument | 無効な入力パラメーター |
2008 | invalid video error | 無効な動画(ビデオの持続時間は2s未満) |
4007 | liveness silent check failed | サイレント生体認証に失敗 |
ステータスコード | ステータスフィールド |
400 | BAD_REQUEST |
404 | NOT_FOUND |
411 | LENGTH_REQUIRED |
413 | PAYLOAD_TOO_LARGE |
500 | INTERNAL_ERROR |
フィールド | 型 | 説明 |
code | int | システムレスポンスコード |
message | string | エラーメッセージ |
request_id | string | リクエストのID |
コード | フィールドの値 | 説明 |
1200 | invalid argument | 無効な入力パラメーター |
2003 | invalid image size | 写真サイズ(幅と高さのピクセル数)が要件を満たしていません |
2004 | invalid content length | 写真のファイルサイズが要件を満たしていません |
2005 | invalid image type | 写真タイプが要件を満たしていません |
4000 | detection failed | 特徴の抽出に失敗しました。写真に顔が検出されませんでした |
ステータスコード | ステータスフィールド |
400 | BAD_REQUEST |
404 | NOT_FOUND |
411 | LENGTH_REQUIRED |
413 | PAYLOAD_TOO_LARGE |
500 | INTERNAL_ERROR |
フィールド | 型 | 説明 |
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の場合に返されます |
request_id | string | リクエストのID |
ステータス | 説明 |
ok | サイレント生体認証は合格:動画の中の人は実在する |
hack | サイレント生体認証は不合格。理由:捏造した顔(例えば, ビデオで撮影された顔など) |
short_time | サイレント生体認証は不合格。理由:ビデオの持続時間は2s未満など |
閾値 | 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 |
フィールド | 型 | 説明 |
code | int | システムレスポンスコード |
message | string | エラーメッセージ |
request_id | string | リクエストのID |
コード | フィールドの値 | 説明 |
1200 | invalid argument | 無効な入力パラメーター |
2003 | invalid image size | 画像サイズ(幅と高さのピクセル数)が要件を満たしていません |
2004 | invalid content length | 画像のファイルサイズが要件を満たしていません |
2005 | invalid image type or corrupted | 画像タイプが要件を満たしていません |
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 |
閾値 | 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 |
フィールド | 型 | 説明 |
code | int | システムレスポンスコード |
message | string | エラーメッセージ |
request_id | string | リクエストのID |
コード | フィールドの値 | 説明 |
1200 | invalid argument | 無効な入力パラメーター |
2003 | invalid image size | 画像サイズ(幅と高さのピクセル数)が要件を満たしていません |
2004 | invalid content length | 画像のファイルサイズが要件を満たしていません |
2005 | invalid image type or corrupted | 画像タイプが要件を満たしていません |
2007 | corrupted liveness data 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 |
return_image | boolean | No | 選出されたフレーム写真と選出されたフレーム写真のタイムスタンプを返すかどうかを指定します。デフォルト値はfalseで、値がtrueかつ生体認証が通過した場合に |
return_face_image | boolean | No | 選出されたフレーム写真の顔のクロップを返すかどうかを指定します。。 デフォルト値はfalseで、値がtrueかつ生体認証が通過した場合に |
return_status | boolean | No | エラーステータスの説明を返すかどうかを指定します。デフォルトはfalseで、値がtrueの場合にのみ |
フィールド | 型 | 説明 |
code | int | システムレスポンスコード:1000 |
passed | boolean | 生体認証に通過したかどうか |
liveness_score | float | サイレント生体認証のスコア(参考までに、結果はpassedフィールドを使用してください) |
liveness_status | string | サイレントライブネス検出のエラー状態を記述します。このフィールドは、return_status=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の場合に返されます |
request_id | string | リクエストのID |
フィールド | 型 | 必須 | 説明 |
encrypted_image | string | Yes |
フィールド | 型 | 説明 |
code | int | システムレスポンスコード:1000 |
faces | array | 写真に写っている各顔のクオリティについての情報 |
request_id | string | リクエストのID |
フィールド | 型 | 必須 | 説明 |
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かつ生体認証が通過した場合に |
return_face_image | boolean | No | 選出されたフレーム画像の顔のクロップを返すかどうかを指定します。 デフォルト値はfalseで、値がtrueかつ生体認証が通過した場合に |
return_status | boolean | No | エラーステータスの説明を返すかどうかを指定します。デフォルトはfalseで、 |
フィールド | 型 | 必須 | 説明 |
liveness_file | file | Yes | 生体検知SDKによる検出に成功した後に返された暗号化されたバイナリ・ストリーム・ファイル(例:protobufData)です。既に暗号化されているので、別途暗号化を必要としません |
encrypted_image | string | Yes |
auto_rotate | boolean | No | デフォルト値はfalseで、画像が回転していないことを示します。値がtrueの場合、画像は自動的に回転されます |
check_quality | boolean | No | デフォルト値がfalseの場合は品質チェックを行わず、trueの場合は画像の品質チェックを行います |
フィールド | 型 | 説明 |
code | int | システムレスポンスコード:1000 |
verification_score | float | 顔照合スコア、値0〜1、値が高いほど同一人物である可能性が高いことを示します |
request_id | string | リクエストのID |
暗号化された動画。暗号化方法の参照:
暗号化された写真。暗号化方法の参照:
暗号化された動画。暗号化方法の参照:
暗号化された画像 。暗号化方法の参照:
暗号化された画像 。暗号化方法の参照: