API: Factor/badness - 不良行为查询
概览
Factor/badness
是submail的不良行为查询API。
提醒:该接口不会验证身份证号码和姓名是否一致。如果两者不一致,会返回‘查无记录’或者‘请检查身份证号码的有效性’的结果。
为提高用户体验,请用户尽可能保证身份证号码和姓名的一致性(推荐使用身份证二要素验证两者是否一致),再使用此接口
URL
<主> http://tpa.mysubmail.com/factor/badness
<备> https://tpa.mysubmail.com/factor/badness
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 | 必需 | 无 | 用户姓名 |
返回参数格式
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' ,
// API流水号
'send_id' : "********************************",
'result' : {
//结果状态码 01:无记录 02:有记录
'code' => '02',
//结果描述
'msg' => 'ok',
//不良详情 如果存在多个身份类型,用英文逗号隔开
'tag' => '在逃,涉案(包括在逃撤销)',
//验证人身份证号码
'idCardNo' => "********************************",
//验证人姓名
'idCardName' => "********************************",
};
}
无记录返回
{
"status": "success",
"send_id": "********************************",
"result": {
"code": "01",
"msg": "无记录",
"tag": "-",
"idCardNo": "********************************",
"idCardName": "********************************",
}
}