接入文档
FaceID基础版
H5接入
接入指引
接入指引

# 一、准备工作

在正式集成前,需要做一些准备工作,完成FaceID控制台(https://faceid.com/faceopen/login)账号申请、apikey和apisecret申请,场景配置等,具体如下:

# Step1:获取FaceID控制台账号

1.1 线下联系对应商务,开通FaceID控制台账号

# Step2:获取api_key 和api_secrect

2.1 线下联系对应商务,申请api_key 和api_secrect

2.2 登录FaceID控制台,应用配置-apikey管理中查看

# Step3:创建场景配置(可选)

接口入参中场景id:scene_id为非必填,客户可不传(不传默认走蓝色主题色配置)

3.1 登录FaceID控制台,应用配置-场景配置-移动端H5(lite)-创建移动端H5场景

3.2 场景配置项说明

配置项 可配置内容 说明 默认值
场景ID 手动输入(只能输入英文或数字) 用于get_token接口入参的场景ID
场景名 手动输入(可输入中文、英文、数字) 记录该配置用在的业务场景
场景描述 手动输入(可输入中文、英文、数字) 记录该配置用在的业务场景 无(非必填)
版本选择 1、lite2.0
2、lite1.0
Lite1.0仅能支持数字活体录制
Lite2.0能支持数字活体录制、静默活体录制、炫彩活体RTC、静默活体RTC、灵动活体RTC、距离活体RTC、意愿活体RTC七种活体方式
Lite 2.0
身份证识别结果不可编辑字段 1、身份证号码
2、姓名
3、身份证有效期
4、签发机关
配置身份证OCR识别后的信息是否可编辑 均可编辑
身份证图片上传次数上限 1-10次 一次验证流程中,用户最多可以上传几次自拍视频 5次
视频上传次数上限 1-5次 在一次验证流程中,用户最多可以上传几次自拍视频 5次
流程超时时长 1、5分钟
2、10分钟
3、15分钟
4、30分钟
5、60分钟
在一次验证流程的超时时长,计时从调用get_token 开始 60分钟
iOS版微信H5跳转页面大图 手动上传 提供宽高750 x 750 的背景透明的png图像,替换掉微信H5跳转页面的默认图像
安卓版微信H5跳转页面大图 手动上传 提供宽高750 x 750 的背景透明的png图像,替换掉微信H5跳转页面的默认图像
是否展示验证流程首页 1、展示
2、不展示
- 展示
验证流程首页标题 手动输入 验证流程首页标题的内容 -
验证流程次页及后续页主题颜色 手动输入RGB - 83,122,229
降级后,是否展示活体流程引导页 1、是
2、否
-
是否显示退出按钮 1、是
2、否
-
是否展示页面提示文案 1、展示
2、不展示
提醒用户确认本人意愿的提示,如勾选展示,将展示于验证流程的各页面中。 不展示

# 二、方案接入

# Step1:获取token

通过FaceID 后台获取api_key 和api_secrect,并根据业务所需参数调用get_token接口,获取token;

# Step2:跳转H5 验证页面,用户进行操作

通过token参数在浏览器访问DoVerification 地址(https://api.megvii.com/faceid/lite/do?token=xxx),跳转到旷视提供的验证页面;验证完成后跳转到您设定的return_url页面;

# Step3:获取验证结果

通过调用get_result接口进行验证结果反查。

验证结果判断方法:

3.1 首先判断“status”是否为“OK”,status为OK表示完成了FaceID H5 Lite验证流程

3.2 再判断“liveness_result”的结果是否为“PASS”,“liveness_result”为活体检测结果,检测是否被攻击(在getToken的时候fmp_mode为0时,该字段有效。)

3.3 最后判断“verify_result”的结果中“confidence”是否大于置信度阈值“thresholds”,“verify_result”为人脸比对结果,大于置信度阈值的话我们认为是同一个人

# 三、流程图

该文档未解决您的疑问?查看常见问题