2.9 認証用顔写真の API

2.9.1 顔の数の検知 (/api/v1/recognition/check)

概要

認証用顔写真内の顔の数を特定します。

リクエストアドレスの例

https://HOST:PORT/api/v1/recognition/check

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名	型	必須	説明
face_avatar	file	Yes	認証用顔写真
app_key	string	Yes	Appキー
sign	string	Yes	シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp	string	Yes	タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": 4
}

レスポンスのフィールド

パラメーター名	型	説明
code	int	リターンコード
message	string	リターンメッセージ
desc	string	不正なリターンの説明
data	int	顔の数

エラーレスポンスのフィールド

コード	メッセージ	説明
30001	Param Invalid	認証用顔写真のタイプが不正です
30003	No Face Detected In The Image	顔が検出されませんでした。

2.9.2 認証用顔写真品質の検出 (/api/v1/recognition/quality)

概要

認証用顔写真の品質を検出します。

リクエストアドレスの例

https://HOST:PORT/api/v1/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名	型	必須	説明
face_avatar	file	Yes	認証用顔写真
app_key	string	Yes	Appキー
sign	string	Yes	シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp	string	Yes	タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "qa_code": 1030301,
        "qa_desc": "the face pose pitch score is [22.19]-float",
        "qa_msg": "BAN:the face pose pitch is substandard"
    }
}

レスポンスのフィールド

パラメーター名	型	説明
qa_code	int	リターンコード
qa_msg	string	リターンメッセージ
qa_desc	string	リターンの説明

qa_code の説明

リターンコード	リターンメッセージ	リターンの説明
0	PASS	通過
101	BAN:face count is over the max	顔の数が最大数の制限を超えています
10201	BAN:image size wrong, two small	認証用顔写真が小さすぎます
10301	BAN:the alignment score is substandard	検知スコアが低すぎます
1030201	BAN:the face rect's pixels is too low	顔フレームのピクセルが少なすぎます
1030301	BAN:the face pose pitch is substandard	ピッチ角が大きすぎます
1030302	BAN:the face pose yaw is substandard	転向角が大きすぎます
1030303	BAN:the face pose roll is substandard	ロール角が大きすぎます
10401	BAN:the face quality{distance to center} is substandard	対面距離が基準を満たしていません
10402	BAN:the face quality{face size} is substandard	顔サイズ比が小さすぎます（顔の長方形の領域／ 画像領域）
10403	BAN:the face quality{face cover} is substandard	顔が遮られすぎています
10404	BAN:the face quality{brightness} is substandard	明るさが基準を満たしていません
10405	BAN:the face quality{sharpness} is substandard	明度が基準を満たしていません。（写真がぼやけています）
10406	BAN:the face quality{mouth opened} is substandard	口が開き過ぎています
10407	BAN:the face quality{face missing} is substandard	欠けた顔が多すぎます

エラーレスポンスのフィールド

コード	メッセージ	説明
30001	Param Invalid	無効なパラメーターです
30001	Param Invalid	写真が大きすぎます
30005	Avatar File Illegal	ファイルのサイズが大きすぎます
30005	Avatar File Illegal	処理中にエラーが発生しました
30006	Face Number Invalid	無効な顔です
50002	Internal Server Error	シリアル化エラー