点击右侧按钮复制完整请求地址，参数值请替换为实际有效值

请求参数 （暂无请求参数）

请求参数说明

|  名称 |  类型 |是否必填   | 说明  |
| ------------ | ------------ | ------------ | ------------ |
| appid  |  varchar |  是 | 服务商分配的唯一标识  |
| timestamp |  number | 是  | 当前时间的毫秒数  |
| sign  | varchar  | 是  | 签名，<a href='#sign'>签名算法说明</a>  |
| returnUrl | varchar  | 是  | 活体检测成功后跳转的页面的url  |
|actionLiveParam|varchar | 否  |自定义动作，用英文逗号分隔，例如：BlinkEye,LookFront。默认不需要填写|
|colorLiveParam|varchar|否|自定义闪光颜色，用英文逗号分隔，例如：#FFFFFF,#000000。默认不需要填写|

actionLiveParam:动作数组，默认不开启。动作指定一个或多个动作时开启动作活体。动作参数如下：
LookFront：直视摄像头
LookLeft：向左转头
LookRight：向右转头
LookUp：抬头
LookDown：低头
OpenMouth：张嘴
BlinkEye：眨眼
ShakeHead：摇头
NodHead：点头

colorLiveParam：闪光颜色数组。默认不开启闪光活体。闪光活体通过亮色和暗色交替闪烁进行活体判断。数组颜色指定两个或多个颜色时，须同时包含亮色和暗色，系统将随机在提交的颜色中选取亮色光和暗色光交替闪烁。颜色数组不区分顺序，从系统提供的颜色中配置。推荐使用亮色#FFFFFF 和暗色：#000000。
系统提供 14 种闪光颜色：
亮色：#FFFFFF，#FFD9E3，#D8D6FF，#CFF9FF，#FFCEFD，#D8FFCD，#FFF4CB。
暗色：#000000，#3B3C04，#183C03，#063C28，#063C3A，#060D3C，#3C0636。
**备注：闪光活体在直视摄像头时启动，和动作活体同时使用时，必须设置LookFront 直视动作。单独使用闪光活体时，可不设置动作活体参数。**

返回参数 （暂无返回参数）

返回参数说明

|  字段名 | 说明  |  
| ------------ | ------------ |
| success  | 接口请求成功标识，true为成功，false为失败，失败情况下，会有对应描述和状态码  |   
| code  |成功为200，其它为失败状态码   | 
| msg  | code对应的说明描述   | 
| data  |结果详细信息|  
| token  | 活体检测凭证，一个token只能进行一次活体检测，有效期10分钟   |  


# 二.请求H5活体检测页面
#### 描述：请求URL: https://liveness.shuliancloud.com/index?token=第一步获取的token ，检测完成后跳转到第一步returnUrl页面。


# 接口名称：三.查询活体检测结果
#### 描述：查询第二步活体检测结果
请求地址 url：https://api.shuliancloud.com/v4/liveness/h5/result
请求方式 method：get/post
参数：

|  名称 |  类型 |是否必填   | 说明  |
| ------------ | ------------ | ------------ | ------------ |
| appid  |  varchar |  是 | 服务商分配的唯一标识  |
| timestamp |  number | 是  | 当前时间的毫秒数  |
| sign  | varchar  | 是  | 签名，<a href='#sign'>签名算法说明</a>  |
| token | varchar  | 是  | token凭证  |

#### 正确返回：
```
{
    "msg": "成功",
    "success": true,
    "code": 200,
    "data": {
        "order_no": "101421719479660254",
        "token": "202307051502d86ab8d639a140daac53",
        "result": 0,  //0通过;1不通过；2未找到活体检测结果  
        "faceImage": "Qelm5Q5DT5KMxkP4nF0IOeVXOyaHBzQNNWpuob1YEwWG+A0BE9MYb+QKLfRyHIRinAqs"
    }
}
```
#### 错误返回：
```
{
    "msg": "参数错误", 
    "success": false, 
    "code": 400, 
    "data": { }
}
```
#### 返回字段说明：

|  字段名 | 说明  |  
| ------------ | ------------ |
| success  | 接口请求成功标识，true为成功，false为失败，失败情况下，会有对应描述和状态码  |   
| code  |成功为200，其它为失败状态码   | 
| msg  | code对应的说明描述   | 
| data  | 验证结果详细信息|  
| result  | 0-通过 收费; 1-不通过 收费；2-未找到活体检测结果  |  
|faceImage|人脸图片base64字符串