接入文档
FaceID海外基础版(中文)
APP接入
API接口
比对认证
比对认证
# 版本
3.0.0
# 描述
此接口用于将FaceID MegLiveStill SDK 所获得的数据进行上传,并获取活体验证、人脸比对、攻击防范等结果信息。
注意:本接口仅支持FaceID MegLiveStill SDK 3.0及以上版本的数据
# 调用URL
新加坡:https://api-sgp.megvii.com/faceid/v3/sdk/verify
印尼:https://api-idn.megvii.com/faceid/v3/sdk/verify
注意:在生产环境中,请使用HTTPS的通信方式。HTTP方式的通信属于不安全链路,存在安全风险,请勿在生产环境中使用。在生产环境中使用HTTP方式的,将无法得到服务可靠性保障
# 调用方法
POST 注意:用 form-data 格式请求
# 权限
仅当用户接入FaceID产品后,才能调用FaceID各Web API。接入FaceID的流程请咨询FaceID商务人员
# 参数
必选/可选 | 参数 | 类型 | 参数说明 |
---|---|---|---|
必选 | sign | String | 调用此API客户的签名,具体的签名产生方式请查阅App-鉴权说明 |
必选 | sign_version | String | 签名算法版本号,请传递:hmac_sha1 |
必选 | biz_token | String | 通过”App-GetBizToken“ API接口获取到的biz_token |
必选/可选 | meglive_data | File |
|
# 返回值说明
参数类别 | 参数 | 类型 | 参数说明 | ||||||||||||||||||||||||||||||
#基础返回信息 | request_id | String | API 调用的流水号 | ||||||||||||||||||||||||||||||
biz_no | String | 传入的业务流水号,原封不动地返回 | |||||||||||||||||||||||||||||||
time_used | Int | 整个请求所花费的时间,单位为毫秒。此字段必定返回 | |||||||||||||||||||||||||||||||
error | String | 当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节,否则此字段不存在 | |||||||||||||||||||||||||||||||
#状态码 | result_code | Int |
表示本次验证的结果状态码。可结合result_code和result_message字段知晓具体的结果及原因:
|
||||||||||||||||||||||||||||||
#状态码描述 | result_message | String | 可通过此字段信息知晓具体的原因。具体见:result_code & result_message 对照表 | ||||||||||||||||||||||||||||||
#比对结果 | verification | Json |
|
||||||||||||||||||||||||||||||
#攻击结果 | attack_result | Json |
当“result状态码非4200系列”时,本字段才会返回:
|
||||||||||||||||||||||||||||||
#设备攻击信息描述 | device_risk_info | Json |
设备风险检测结果:
|
||||||||||||||||||||||||||||||
#附加返回信息 | images | Json |
一组照片列表,后续会根据采集的照片增加对应的照片字段
|
||||||||||||||||||||||||||||||
video_key | String | 解密密钥,用于获取SDK端保存的视频及图片 | |||||||||||||||||||||||||||||||
visual_attributes | Json |
附加属性:
|
|||||||||||||||||||||||||||||||
verify_risk_info | Json |
比对风险提示结果:
|
# 返回值示例
正确请求返回示例
{
"time_used":1448,
"verification":{
"ref1":{
"confidence":86.63057,
"thresholds":{
"1e-3":51.244865,
"1e-5":75.758,
"1e-4":58.77636,
"1e-6":79.041
}
}
},
"attack_result":{
"score":0.26,
"threshold":0.5,
"result":False
},
"risk_info":{
"device_info_level": "2",
"device_info_tags": {"is_root":0,"is_hook":1,"is_injection":1,"is_virtual_environment":1}
},
"request_id":"1531397565,39b19451-393c-4fc4-8fae-6dc74b2b00d7",
"images":{
"image_best":"xxxxxxxxxxx"
},
"biz_no":"",
"result_message":"SUCCESS",
"result_code":1000
}
失败请求返回示例
{
"error": "AUTHORIZATION_ERROR: INVALID_SIGN"
}
# result_code & result_message 对照表
result_code | result_message | 含义解释 | 是否计费 |
---|---|---|---|
1000 | SUCCESS | 活体验证通过、比对通过 | 是 |
2000 | PASS_LIVING_NOT_THE_SAME | 活体验证通过、比对失败 | 是 |
4100 | FAIL_LIVING_FACE_ATTACK | 未经过活体判断,可能的原因:是假脸攻击 | 否 |
4100 | VIDEO_LACK_FRAMES | 获取到的活体数据故障,请换一台手机重试 | 否 |
4100 | FAIL_EYES_CLOSE_DETECTION | 未通过闭眼检测,活体失败 | 否 |
4100 | DEVICE_RISK | 检测到设备攻击,活体未通过 | 否 |
4200 | BIZ_TOKEN_DENIED | 传入的 biz_token 不符合要求 | 否 |
4200 | AUTHENTICATION_FAIL | 鉴权失败 | 否 |
4200 | MOBILE_PHONE_NOT_SUPPORT | 手机在不支持列表里 | 否 |
4200 | SDK_TOO_OLD | SDK版本过旧,已经不被支持 | 否 |
4200 | MOBILE_PHONE_NO_AUTHORITY | 没有权限(运动传感器、存储、相机) | 否 |
4200 | USER_CANCELLATION | 用户活体失败,原因可能如下:用户取消了、验证过程超时等原因 | 否 |
4200 | USER_TIMEOUT | 用户活体失败,原因可能如下:用户取消了、验证过程超时等原因 | 否 |
4200 | VERIFICATION_FAILURE | 用户活体失败,原因可能如下:用户取消了、验证过程超时等原因 | 否 |
4200 | UNDETECTED_FACE | 用户活体失败,原因可能如下:用户取消了、验证过程超时等原因 | 否 |
4200 | ACTION_ERROR | 用户活体失败,原因可能如下:用户取消了、验证过程超时等原因 | 否 |
4200 | GET_CONFIG_FAIL | 用户活体失败,原因:读取配置失败 | 否 |
# 错误码列表
HTTP状态码 | 错误信息 | 说明 |
---|---|---|
400 | IMAGE_ERROR_UNSUPPORTED_FORMAT:<param> | 参数<param>对应的图像无法解析,有可能不是图像文件、或有数据破损。<param>为 image_ref1、 image_ref2中的一个。请注意:<param>只会有一项,即第一个满足条件的名称 |
400 | MISSING_ARGUMENTS:<key> | 缺少某个必选参数 |
400 | BAD_ARGUMENTS:<key> | 某个参数解析出错(比如必须是数字,但是输入的是非数字字符串; 或者长度过长) |
400 | NO_FACE_FOUND:<param> | 表示上传的 image_ref 的图像中,没有检测到人脸 |
400 | INVALID_IMAGE_SIZE:<param> | 上传的图像太大,具体是指像素尺寸的长或宽超过4096像素。<param>为 image_ref1、 image_ref2中的一个。请注意:<param>只会有一项,即第一个满足条件的名称 |
400 | MEGLIVE_DATA_ERROR | 上传的meglive_data数据包解析失败。请将SDK产生的meglive_data数据包直接传递到此API,任何对数据包的修改都会导致数据包解析失败的问题 |
400 | MEGLIVE_DATA_BIZ_TOKEN_NOT_MATCH | 上传的meglive_data包中的biz_token和传入参数biz_token不一致 |
400 | FMP_CONTENT_TYPE_ERROR | 视频错误,请重试或更换手机重试 |
403 | AUTHORIZATION_ERROR:<reason> |
api_key被停用、调用次数超限、没有调用此API的权限,或者没有以当前方式调用此API的权限
<reason>取值:
|
403 | CONCURRENCY_LIMIT_EXCEEDED | 并发数超过限制 |
404 | API_NOT_FOUND | 所调用的API不存在 |
413 | Request Entity Too Large | 客户发送的请求大小超过了20MB限制或单张照片大小超过了2MB。该错误的返回格式为纯文本,不是json格式 |
500 | INTERNAL_ERROR | 服务器内部错误,当此类错误发生时请再次请求,如果持续出现此类错误,请及时联系FaceID客服或商务 |
该文档未解决您的疑问?查看常见问题