接入文档![](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmVyc2lvbj0iMS4xIj4KIDxnIGZpbGw9IiM3MDcwNzgiPgogIDxwb2x5Z29uIHBvaW50cz0iOC4zOTc3NzgwMzQyMTAyMDUsMCA5LjQzNTgwMzg5MDIyODI3MSwwIDQuNzE3ODc3Mzg4MDAwNDg4LDEyIDMuNjg0MDMzMzkzODU5ODYzMywxMiAiLz4KIDwvZz4KPC9zdmc+Cg==)
FaceID海外基础版(中文)![](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmVyc2lvbj0iMS4xIj4KIDxnIGZpbGw9IiM3MDcwNzgiPgogIDxwb2x5Z29uIHBvaW50cz0iOC4zOTc3NzgwMzQyMTAyMDUsMCA5LjQzNTgwMzg5MDIyODI3MSwwIDQuNzE3ODc3Mzg4MDAwNDg4LDEyIDMuNjg0MDMzMzkzODU5ODYzMywxMiAiLz4KIDwvZz4KPC9zdmc+Cg==)
APP接入![](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmVyc2lvbj0iMS4xIj4KIDxnIGZpbGw9IiM3MDcwNzgiPgogIDxwb2x5Z29uIHBvaW50cz0iOC4zOTc3NzgwMzQyMTAyMDUsMCA5LjQzNTgwMzg5MDIyODI3MSwwIDQuNzE3ODc3Mzg4MDAwNDg4LDEyIDMuNjg0MDMzMzkzODU5ODYzMywxMiAiLz4KIDwvZz4KPC9zdmc+Cg==)
API接口![](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmVyc2lvbj0iMS4xIj4KIDxnIGZpbGw9IiM3MDcwNzgiPgogIDxwb2x5Z29uIHBvaW50cz0iOC4zOTc3NzgwMzQyMTAyMDUsMCA5LjQzNTgwMzg5MDIyODI3MSwwIDQuNzE3ODc3Mzg4MDAwNDg4LDEyIDMuNjg0MDMzMzkzODU5ODYzMywxMiAiLz4KIDwvZz4KPC9zdmc+Cg==)
获取token
获取token
# 版本
1.0.0
# 描述
此接口用于配置人脸比对参数,支持人脸核身和人脸比对。客户通过服务器将本次活体相关的配置传到FaceID服务器,在验证无误后,返回本次业务的biz_token,用于FaceID MegLiveStill SDK的初始化。
注意:本接口仅支持FaceID MegLiveStill SDK 3.0及以上的版本来获取biz_token进行初始化。
# 调用URL
新加坡:https://api-sgp.megvii.com/faceid/v3/sdk/get_biz_token
印尼:https://api-idn.megvii.com/faceid/v3/sdk/get_biz_token
注意:在生产环境中,请使用HTTPS的通信方式。HTTP方式的通信属于不安全链路,存在安全风险,请勿在生产环境中使用。在生产环境中使用HTTP方式的,将无法得到服务可靠性保障。
# 调用方法
POST 注意:用 form-data 格式请求
# 权限
仅当用户接入FaceID产品后,才能调用FaceID各Web API。接入FaceID的流程请咨询FaceID商务人员。
# 参数
必选/可选 | 参数 | 类型 | 参数说明 | |
---|---|---|---|---|
必选 | sign | String | 调用此API客户的签名,具体的签名产生方式请查阅App-鉴权说明 | |
必选 | sign_version | String | 签名算法版本,请传递:hmac_sha1 | |
必选 | liveness_type | String |
活体验证流程的选择,目前仅取以下值:
|
|
必选 | comparison_type | String |
确定本次比对类型。取值只为“0”,取其他值返回错误码400(BAD_ARGUMENTS)
|
|
必选 | uuid | String | 如果用户不使用参考数据进行比对,则上传此字段,用于标志本次识别对应的用户的唯一ID,要求不长于128字节。建议您对来自同一用户的比对请求使用同样的ID,这非常有利于您反查验证结果以及获得更好的数据报表体验 | |
必选 | image_ref1 | File | 由客户提供的参照人脸照片。 如果在image_ref1、image_ref2中的任一张图片里没有找到人脸,将返回错误码400(NO_FACE_FOUND); 如果这些图片中任一张中有多张脸,将选择最大人脸进行比对 | |
可选 | image_ref2 | File | 由客户提供的参照人脸照片。 如果在image_ref1、image_ref2中的任一张图片里没有找到人脸,将返回错误码400(NO_FACE_FOUND); 如果这些图片中任一张中有多张脸,将选择最大人脸进行比对 | |
可选 | biz_no | String | “默认为空”。客户业务流水号,建议设置为您的业务相关的流水串号并且唯一,会在return时原封不动的返回给您的服务器,以帮助您确认对应业务的归属。此字段不超过128字节 | |
可选 | liveness_timeout | String |
超时时间,示用户进入活体识别流程后的超时时间,若未在规定时间完成操作,则本次活体失败
超时时间设定:单位 秒, ∈ [5, 60]
|
|
活体类型控制四选一:动作活体时(liveness_type = meglive) | 可选 | liveness_action_count | String | 配置动作活体时的动作个数:默认3个动作;默认3, ∈ [1,3] |
可选 | face_replace_detection | String |
|
|
活体类型控制:静默活体、炫彩活体时(liveness_type = still、flash) | 可选 | eyes_close_detection | String |
表示静默活体和炫彩活体是否进行闭眼检测,取值如下:
|
活体类型控制四选一:炫彩活体时(liveness_type = flash) | 可选 | flash_liveness_timeout | String |
设置炫彩活体的超时时间,默认值为 120秒。表示用户进入活体识别流程后的超时时间,若未在规定时间完成操作,则本次活体失败
超时时间设定:单位 秒, ∈ [60, 180]。若参数值超过限定范围,则返回BAD_ARGUMENTS错误 |
活体类型控制四选一:无活体验证时(liveness_type = raw_image) | 必选 | image | File | 待比对的人脸照片。当以这种方式调用时,该方法会首先检测出image中有几张人脸,并且判断最大的那张人脸的图像质量是否足够后续的比对。您可以通过设置可选参数fail_when_multiple_faces 和 face_quality_threshold来定义人脸检测方面的行为 |
可选 | fail_when_multiple_faces | String |
对待比对照作人脸检测时发现有多张脸,是否立即返回错误,或者取最大的一张脸继续比对。本参数取值只能是 “1” 或 "0" (默认值为“1”):
|
|
可选 | face_quality_threshold | String | 待比对照中(人脸面积最大的一张)人脸图像质量分的阈值(默认值为30)。待比对照人脸图像质量低于该阈值就直接返回错误码400(LOW_QUALITY)。本参数只能传入0至100的整数,传入其他整数或非整数字符串均返回错误码400(BAD_ARGUMENTS) | |
可选 | return_faces | String |
返回人脸检测结果。本参数取值只能是“1”或“0”(默认值为“0”):
|
|
可选 | verbose | String |
表示返回数据的详细程度,取值如下:
|
|
可选 | security_level | String |
表示对比对结果的严格程度限制,请根据您的场景,选择安全规则,越严格,准确性要求越高,通过率也会相应下降
|
|
可选 | force_compare | String |
表示云端算法判断为假脸后,是否依然进行比对结果
|
|
可选 | multi_oriented_detection | String |
决定对于image_ref[x]参数对应的图片,当检测不出人脸时,是否旋转90度、180度、270度后再检测人脸。本参数取值只能是 “1” 或 "0"
|
|
可选 | maximum_brightness | String |
表示活体SDK进入活体时是否将屏幕亮度调到最大,取值如下:
|
|
可选 | get_liveness_video | String |
本参数用来控制是否需要留存活体阶段视频及图片,可选参数设置如下:
保存的视频及图片加密存储在SDK端,在调用verify接口后返回秘钥至客户服务端,密钥字段为video_key |
|
可选 | device_risk | String |
控制是否开启设备风险检测
|
|
可选 | multiple_faces_detection | String |
活体过程中是否检测多人脸
|
|
可选 | verify_risk_detect | String |
是否开启比对风险检测。开启后,则返回视觉属性及比对风险提示结果
|
# 返回值说明
字段 | 类型 | 说明 |
---|---|---|
request_id | String | 用于区分每一次请求的唯一的字符串。此字符串可以用于后续数据反查。此字段必定返回 |
time_used | Int | 整个请求所花费的时间,单位为毫秒。此字段必定返回。 |
biz_token | String | 字符串,调用SDK时传入的信息。注:biz_token唯一且只能使用一次,且有效期为1小时 |
error | String | 当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在 |
# 返回值示例
正确请求返回示例
{
"biz_token":"1531397038,f0b9eea0-6a2d-486c-a1ba-42fdf843e8cc",
"time_used":18,
"request_id":"1531397037,c1223c5b-c2f6-4bb7-8cbb-8993497ddbe0"
}
失败请求返回示例
{
"error": "BAD_ARGUMENTS: sign_version"
}
# 错误码列表
HTTP状态代码 | 错误信息 | 说明 |
---|---|---|
400 | MISSING_ARGUMENTS: <key> | 缺少某个必选参数 |
400 | BAD_ARGUMENTS: <key> | 某个参数解析出错(比如必须是数字,但是输入的是非数字字符串; 或者长度过长) |
400 | IMAGE_ERROR_UNSUPPORTED_FORMAT:<param> | 参数<param>对应的图像无法解析,有可能不是图像文件、或有数据破损。<param>为 image_ref1、 image_ref2中的一个。请注意:<param>只会有一项,即第一个满足条件的名称 |
400 | NO_FACE_FOUND:<param> | 表示上传的 image_ref 的图像中,没有检测到人脸。<param>为 image_ref1、 image_ref2、image中的一个。请注意:<param>只会有一项,即第一个满足条件的名称 |
400 | INVALID_IMAGE_SIZE<param> | 客户上传的图像太大,具体是指像素尺寸的长或宽超过4096像素。<param>为 image_ref1、 image_ref2中的一个。请注意:<param>只会有一项,即第一个满足条件的名称 |
400 | LOW_QUALITY | image图片质量太差 |
400 | MULTIPLE_FACES | image图片中有多张人脸 |
403 | AUTHENTICATION_ERROR | 无效签名 |
403 | AUTHORIZATION_ERROR: <reason> |
api_key被停用、调用次数超限、没有调用此API的权限,或者没有以当前方式调用此API的权限
<reason>取值:
|
403 | CONCURRENCY_LIMIT_EXCEEDED | 并发数超过限制 |
404 | API_NOT_FOUND | 所调用的API不存在 |
413 | Request Entity Too Large | 客户发送的请求大小超过了10MB限制。该错误的返回格式为纯文本,不是json格式 |
500 | INTERNAL_ERROR | 服务器内部错误,当此类错误发生时请再次请求,如果持续出现此类错误,请及时联系 FaceID 客服或商务 |
该文档未解决您的疑问?
查看常见问题