API: Factor/raw_video_idcard - 活体检测+人口库验证
概览
Factor/raw_video_idcard
是submail的活体检测+人口库认证API,检查用户拍摄的视频是否为活体,并和人口库照片比对,判断是否是同一人。
URL
<主> http://tpa.mysubmail.com/factor/raw_video_idcard
<备> https://tpa.mysubmail.com/factor/raw_video_idcard
http 请求方式
请求方式 | content-type 设置 |
---|---|
http post | multipart/form-data 、x-www-form-urlencoded 、application/json |
signature创建规则
1. 请将以下参数按照字段升序(A-Z)排列 appkey 、idNo 、name 、timestamp
2. 创建签名字符串 :以"key=value" + "&"(连接符)+ "key=value" 的方式连接所有参数
3. 创建签名:拼接签名字符串示例string = "appkey=xxxx&idNo=xxxx&name=xxxx×tamp=xxxxxxxxxx",然后使用sha256(string)创建签名
注:中文需要使用urlencode处理后再参与创建签名
请求参数
参数 | 类型 | 是否必需 | 默认 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 身份认证服务中创建并且认证通过的应用 ID |
timestamp | string | 必需 | 无 | UNIX 时间戳 |
signature | string | 必需 | 无 | 签名,详细规则看下方介绍 |
idNo | string | 必需 | 无 | 身份证号码 |
name | string | 必需 | 无 | 用户姓名 |
motions | string | 必需 | 无 | 用户动作序列,BLINK 眨眼;MOUTH 张嘴; NOD 点头; YAW 摇头 |
complexity | string | 必需 | 无 | 活体检测通过的难易程度,默认为 0, 0:简单模式;1: 正常模式;2:困难模式;3:地狱模式 |
image_flag | string | 必需 | 无 | 是否需要返回照片,Y/N |
video | file | 必需 | 无 | 视频文件 |
返回参数格式
jsonString
代码示例
详情请查询demo示例文档
响应消息
API请求失败
{
'status' : 'error' , // 状态描述
'send_id' : 'ee05d1635db847a2bf3c8317434539d6', // API流水号
'code' : 1201 , // API返回的状态码 详情查看 API错误代码与描述 文档
'msg' : 'Incorrect APP ID.' , // API返回的描述、
}
API请求成功
{
'status' : 'success' , // 状态描述
'send_id' : 'ee05d1635db847a2bf3c8317434539d6', // API流水号
'result' : {
'identical' => true //验证是否通过 true/false
'status' => '01' //验证是否通过 01 通过 /02 不通过
'featureImage' => ... //image_flag为N返回空,为Y返回图片的base64编码
};
}