主题
活体人脸核身-H5/小程序-获取单据号
接口描述
实时活体人脸核身开始前,需要获取单据号及H5页面Url,作为本次活体识别的唯一凭证。
请求说明
HTTP 方法:
POST请求 URL:
/kaleidoscope-live/live/h5CheckFace/getCertifyHeader如下:
| 参数名称 | 值 |
|---|---|
| Content-Type | application/json;charset=UTF-8 |
Body中放置请求参数,参数详情如下:
请求参数:
| 参数名称 | 必填 | 数据类型 | 长度 | 参数描述 |
|---|---|---|---|---|
| redirectUrl | 是 | String | 1-255 | 回调地址 |
| cId | 否 | String | 1-32 | 身份证号码 若自定义活体方案设置为随接口传入则必传,无方案时为必传,其他情况为非必传 |
| cName | 否 | String | 1-32 | 姓名 若自定义活体方案设置为随接口传入则必传,无方案时为必传,其他情况为非必传 |
| actionScene | 否 | String | 1-32 | 动作场景枚举, 该参数与方案编号同时传时,该参数动作生效; 若未传动作枚举时,使用方案中配置的动作枚举;若均无,则默认为EC(眨眼+光线) |
| busFlowId | 否 | String | 0-64 | 业务流水号,业务系统唯一序列号(对账用,建议传入) |
| planCode | 否 | String | 0-32 | 活体方案编号,在平台上配置,传入可使用自定义方案,不传则使用默认方案 |
请求示例:
{
"actionScene":"EC",
"redirectUrl":"https://www.baidu.com",
"cId":"500233XXXXXXXX0303",
"cName":"钟国梦",
"busFlowId":"035143d350c646f68f4d25e44ff426c3",
"planCode":"xxxxxxxx"
}返回说明
返回参数:
| 返回值名称 | 数据类型 | 长度 | 描述 |
|---|---|---|---|
| code | String | 1-8 | 返回结果,00000000表示成功 |
| message | String | 1-255 | 返回码描述 |
| data | Object | - | 返回的数据 |
| -certifyId | String | 1-32 | 单据号 |
| -h5Url | String | 1-255 | H5页面调用url,使用方法请参考前端接入流程。 |
| -busFlowId | String | 1-64 | 业务流水号,业务系统唯一序列号 |
返回示例:
{
"code": "00000000",
"success": true,
"message": "success",
"data": {
"certifyId": "954809141539430400",
"h5Url": "https://ip:port/#/entry",
"busFlowId": "035143d350c646f68f4d25e44ff426c3"
}
}动作场景枚举
| actionScene | 描述 |
|---|---|
| EC | 光线眨眼 |
| RANDOM | 随机3动作,(局部[眨眼E、张嘴M] + 全脸[左转L、右转R] + 光线C) |
| OEC | 远近眨眼光线 |
错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共CODE码表
| 码值 | 是否成功 | 是否计费 | 描述 |
|---|---|---|---|
| 00000000 | 是 | 否 | 成功 |
| 80002902 | 否 | 否 | 回调地址不能为空 |
| 80002907 | 否 | 否 | 场景码有误 |
| 50029811 | 否 | 否 | 证件号不能为空 |
| 50029813 | 否 | 否 | 证件姓名不能为空 |
H5相关接口计费规则为:拉起获取单据号返回H5页面,页面点击开始检测后,即开始计费