API: Factor/idcard4 - 身份证四要素
概览
Factor/idcard4是submail的身份证四要素认证API，可以根据姓名、身份证号、身份证有效期来判断四者是否一致。
URL
<主> http://tpa.mysubmail.com/factor/idcard4
<备> https://tpa.mysubmail.com/factor/idcard4http 请求方式
| 请求方式 | 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 | 必需 | 无 | 用户姓名 |
begin_date | string | 必需 | 无 | 身份证有效时间-开始时间 格式:20210101 |
end_date | string | 必需 | 无 | 身份证有效时间-结束时间 格式:20210101 长期有效填写 L |
返回参数格式
jsonString
代码示例
详情请查询demo示例文档
响应消息
API请求失败
{
// 状态描述
'status' : 'error' ,
// API流水号
'send_id' : "********************************",
// API返回的状态码 详情查看 API错误代码与描述 文档
'code' : 1201 ,
// API返回的描述
'msg' : 'Incorrect APP ID.' ,
}
{
"status": "error",
"send_id": "********************************",
"code": 1217,
"msg": "API Gateway Error:请检查身份证号码的有效性(****)"
}
API请求成功
{
"status": "success",
"send_id": "********************************",
"result": {
//返回结果描述
"bank_msg": "一致",
//01 一致 02 不一致
"status": "01",
//true 一致 false 不一致
"identical": true,
//身份证号码
"bank_idCard": "*******************",
//姓名
"bank_name": "****",
//身份证有效时间-开始时间
"begin_date": "2022****",
//身份证有效时间-结束时间
"end_date": "2042****"
}
}
认证不一致
{
"status": "success",
"send_id": "********************************",
"result": {
"bank_msg": "不一致",
"status": "02",
"identical": false,
"bank_idCard": "*******************",
"bank_name": "****",
"begin_date": "2022****",
"end_date": "2042****"
}
}