活体检测SDK_v3,我们致力于为用户提供专业的免费API数据接口服务
在线活体检测SDK,通过在线配合动作(张嘴、摇头等),判断是否为真人,检测成功会返回一张人脸照片用于下一步比对验证。适合集成APP使用,支持原生APP、Uni-APP。
https://api.shuliancloud.com/v3/life-sdk/check
https://api.shuliancloud.com/v3/life-sdk/check
点击右侧按钮复制完整请求地址,参数值请替换为实际有效值
| 参数名 | 是否必填 | 参数类型 | 参数说明 |
|---|---|---|---|
| 暂无请求参数信息 | |||
| 名称 | 类型 |是否必填 | 说明 | | ------------ | ------------ | ------------ | ------------ | | appid | varchar | 是 | 服务商分配的唯一标识 | | timestamp | number | 是 | 当前时间的毫秒数 | | sign | varchar | 是 | 签名,<a href='#sign'>签名算法说明</a> | | packageName | varchar | 是 | 包名,先提交给服务商添加白名单 | | signData | varchar | 是 | Base64编码的加密字符串 前端SDK返回的字节数组进行Base64编码后得到 |
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| 暂无返回参数信息 | ||
| 字段名 | 说明 | | ------------ | ------------ | | success | 接口请求成功标识,true为成功,false为失败,失败情况下,会有对应描述和状态码 | | code |成功为200,其它为失败状态码 | | msg | code对应的说明描述 | | data | 验证结果详细信息| | order_no | 订单号| | result | 0活体检测通过,收费;1活体检测未通过,收费;2活体检测异常,不收费| | size | 人脸照片大小| | width | 人脸照片宽度 | height | 人脸照片高度 | sceneImage | 活体场景照片 | faceImage | 活体人脸照片,如果要调人像接口,建议使用该照片 | desc | 描述
# 接口名称:SDK活体检测结果查询
#### 描述:根据SDK返回的加密字符串获取活体检测结果以及人脸照片
请求地址 url:https://api.shuliancloud.com/v3/life-sdk/check
请求方式 method:post
参数:
| 名称 | 类型 |是否必填 | 说明 |
| ------------ | ------------ | ------------ | ------------ |
| appid | varchar | 是 | 服务商分配的唯一标识 |
| timestamp | number | 是 | 当前时间的毫秒数 |
| sign | varchar | 是 | 签名,<a href='#sign'>签名算法说明</a> |
| packageName | varchar | 是 | 包名,先提交给服务商添加白名单 |
| signData | varchar | 是 | Base64编码的加密字符串 前端SDK返回的字节数组进行Base64编码后得到 |
<a name="sign">
#### 签名算法说明:
###### 服务商分配的appid、当前时间毫秒数timestamp、商户分配的app_security、 三者通过&符号拼接成字符串进行md5加密得到。
如:appid=xyzxyzxyz,timestamp=1555378976238,app_security=efcefcefcefcefc ;
拼接后的字符串格式:str = appid的值&timestamp的值&app_security的值;
拼接后的字符串:str = xyzxyzxyz&1555378976238&efcefcefcefcefc ;
加密后得到sign = md5(str) = 4e7e1974b79f3656aeaf03f1158f5d5d ;
</a>
#### 验证通过返回:
```
{
"msg": "成功",
"success": true,
"code": 200,
"data": {
"orderNo": "643194240063456587",
"result": 0,
"size": "56487",
"width": "465",
"height": "632",
"sceneImage": "/9j/4QT0RXhpZgAATU0AKgAAAAgABQEAAA",
"faceImage": "/9j/4QT0RXhpZgAATU0AKgAAAAgABQEAAA",
"desc": "活体检测通过"
}
}
```
#### 验证不通过返回:
```
{
"msg": "成功",
"success": true,
"code": 200,
"data": {
"orderNo": "700883818443839856",
"result": 1,
"size": null,
"width": null,
"height": null,
"sceneImage": null,
"faceImage": null,
"desc": "活体检测不通过"
}
}
```
#### 错误返回:
```
{
"msg": "参数错误",
"success": false,
"code": 400,
"data": { }
}
```
#### 返回字段说明:
| 字段名 | 说明 |
| ------------ | ------------ |
| success | 接口请求成功标识,true为成功,false为失败,失败情况下,会有对应描述和状态码 |
| code |成功为200,其它为失败状态码 |
| msg | code对应的说明描述 |
| data | 验证结果详细信息|
| order_no | 订单号|
| result | 0活体检测通过,收费;1活体检测未通过,收费;2活体检测异常,不收费|
| size | 人脸照片大小|
| width | 人脸照片宽度
| height | 人脸照片高度
| sceneImage | 活体场景照片
| faceImage | 活体人脸照片,如果要调人像接口,建议使用该照片
| desc | 描述
#### code错误码说明
| code | 说明 |
| ------------ | ------------ |
| 200 | 成功 |
| 400 | 参数错误 |
| 404 | 请求资源不存在 |
| 500 | 系统内部错误,请联系服务商 |
| 501 |第三方服务异常
| 601 | 服务商未开通接口权限 |
| 602 | 账号停用 |
| 603 | 余额不足请充值 |
| 604 | 接口停用 |
| 606 | 调用超限,请联系服务商
| 1001 | 其他,以实际返回为准