一、接入前准备
在正式集成前，需要做些准备工作，在控制台账号申请、AccessKey和SecretAccessKey申请。申请步骤详见获取临时密钥（STS）。
二、拼接URL
拼接URL后访问该地址进行身份认证。
域名：https://h5-v2.kych5.com
URL示例：https://h5-v2.kych5.com?accessKeyId=xxx&secretAccessKey=xxx&sessionToken=xxx&configId=xxx&bytedToken=xxx&lng=xxx
accessKeyId、secretAccessKey、sessionToken：临时密钥。configId：套餐配置id。bytedToken：可选字段，Token配置。lng：可选字段，表示页面语言。目前支持简体(zh)、繁体(zh-Hant)、英文(en)，默认zh。
step1、2、3均由服务端对接完成
step1：获取临时密钥
通过控制台获取到AccessKey、SecretAccessKey以后，调用STS接口获得accessKeyId （临时AK）、secretAccessKey （临时SK）、sessionToken （临时token）拼接到URL参数上，用于认证时供服务端接口鉴权，获取方式详见5. 调用STS接口部分。
step2：套餐配置
提供可选的配置参数，适配多样化的客户需求和业务场景，调用服务端接口（参考H5套餐配置）生成configId并拼接到URL参数上。
step3：Token配置
当业务场景为直接进入活体识别不录入身份信息时需要bytedToken 。获取方式详见H5Token配置。
三、认证结束
当结束认证后，身份认证H5会在redirect_url （回调地址在H5套餐配置中设置）地址后面拼接相关的参数，业务侧可解析参数获取认证结果。
/** 拼接示例 **/ ${redirect_url}?resultCode=xxx&algorithmBaseRespCode=xxx&reqMeasureInfoValue=xxx&bytedToken=xxx
认证返回参数说明
参数 | 类型 | 功能描述 |
|---|---|---|
resultCode | string | 通用错误码。若值为10000，则表示认证成功，否则认证失败。 |
algorithmBaseRespCode | string | 服务端子错误码。 |
reqMeasureInfoValue | string | 是否计费，取值为0或1 |
bytedToken | string | H5认证结果查询 接口需要的参数 |
错误码
客户端错误码
resultCode | 说明 |
|---|---|
40001 | 当前设备不支持WebRTC |
40002 | 摄像头权限获取失败 |
40003 | RTC初始化内部错误 |
40004 | 设备录制视频异常 |
40005 | TOS上传异常 |
40006 | 未知错误 |
40007 | 本地图片处理异常 |
40008 | 未检测到设备摄像头硬件 |
40009 | WebSocket连接异常 |
40010 | 当前设备不支持WebSocket |
40011 | WebSocket页面初始化内部错误 |
算法端错误码
resultCode | 说明 |
|---|---|
41000 | 检测尚未完成 |
41002 | 超时未检测到第一张有效人脸 |
41003 | 单个动作超时 |
41006 | 做错动作，可能是视频攻击 |
41007 | 静默活体检测失败 |
41008 | 过程中人脸不一致 |
41009 | 过程中图片质量不合格 |
服务端错误码
resultCode | 说明 |
|---|---|
50200 | 参数错误 |
50201 | 缺少参数 |
50204 | 参数类型错误/参数缺失 |
50205 | 图像尺寸超过限制。输入为图片时可能返回此错误。 |
50206 | 请求参数中没有获取到图像。输入为图片时可能返回此错误。 |
50207 | 图像解码错误。输入为图片时可能返回此错误。 |
50209 | 请求参数中没有获取到视频。输入为视频时可能返回此错误。 |
50210 | 视频解码错误。输入为视频时可能返回此错误。 |
50211 | 视频尺寸超过限制。输入为视频时可能返回此错误。 |
50213 | 请求Body过大，超过10MB限制。 |
50214 | 输入视频时长过大 |
50215 | 请查看认证子错误码了解具体含义。认证子错误码说明见下方。 |
60102 | 算法服务需要输入人脸图，但未检测到 |
50400 | 权限校验失败，没有接口权限/时间戳参数不正确/签名字段错误。 |
50402 | 访问的接口不存在。 |
50429 | 超过调用QPS限制。 |
50500 | 服务器内部错误。 |
50501 | 服务器内部RPC错误。 |
70000 | 网关鉴权失败。可能是临时密钥STS过期。 |
服务端子错误码
algorithmBaseRespCode | 说明 | 是否计费 |
|---|---|---|
0 | 认证一致 | 是 |
100000 | 服务内部错误 | |
100001 | 数据源内部错误 | |
201201 | 缺少输入参数或输入参数为空 | |
201202 | 输入参数不合法 | |
201301 | 输入图片为空 | |
201302 | 输入图片解码失败 | |
201304 | 输入图片无法处理 | |
201403 | 身份证认证次数超出当日上限 | |
201404 | 命中频控黑名单 | |
203101 | 输入图片未检测到人脸 | |
210101 | 输入认证字段不合格（空、不合法等） | |
210102 | 输入认证字段查询不到结果 | |
210103 | 输入认证字段触发源头限流 | |
210104 | 输入认证字段不匹配 | 是 |
210201 | 身份证号为空 | |
210202 | 身份证号无效或不符合规范 | |
210203 | 姓名为空 | |
210204 | 姓名不符合规则 | |
210205 | 身份证查询无结果 | |
210206 | 姓名不匹配 | 是 |
210207 | 认证不一致，姓名与身份证号不匹配 | |
210301 | 人脸图格式不支持 | 是 |
210302 | 人脸图质量不合格/已损坏 | 是 |
210303 | 人脸图大小过小 | 是 |
210304 | 人脸图为空 | |
210305 | 人脸图中未检测到人脸 | |
210306 | 人脸图中存在多个人脸 | |
210307 | 人脸图特征提取失败 | |
210308 | 数据源库中的底图质量不合格 | 是 |
210309 | 数据源库中无该身份信息对应的底图 | 是 |
210310 | 人脸图尺寸过大 | |
210311 | 人脸图不匹配 | 是 |
210312 | 请按动作重做动作 | |
210313 | 认证不一致，疑似本人 | 是 |
210314 | 认证不一致，待对比图像建模失败 | 是 |
210701 | 人脸图质量分数过低 | |
210702 | 人脸图活体分数过低 | |
210703 | 人脸图比对分数过低 | |
210704 | 传入的token参数有误或已过期 | |
210705 | 动作活体重试次数超过上限 | |
210706 | 基准图质量过低 | |
210707 | 基准图不合格 | |
210708 | 基准图没有人脸 | |
210709 | 获取基准图失败 | |
210710 | 获取人脸图失败 | |
210801 | SDKData为空 | |
210802 | SDKData版本异常 | |
210803 | SDKData版本拦截 | |
210804 | SDKData数据有误 | |
210805 | SDKData配置与设置的不相符 | |
210806 | SDK动作活体未通过 | |
210807 | 获取SDKData失败 |
小程序和APP接入比较特殊，需要使用web-view承载H5页面，除 H5接入步骤 外。需要额外配置。
小程序：小程序集成H5。
APP：APP集成H5或者采用SDK接入方式（SDK概览）。