API: Factor/idcard - 身份證二要素
概覽
factor/idcard 是 SUBMAIL 的簡(jiǎn)版身份驗(yàn)證 API，可以根據(jù)身份證號(hào)和姓名判斷兩者是否一致。
URL
<主> http://tpa.mysubmail.com/factor/idcard
<備> https://tpa.mysubmail.com/factor/idcardhttp 請(qǐng)求方式
| 請(qǐng)求方式 | content-type 設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
signature創(chuàng)建規(guī)則
1.請(qǐng)將以下參數(shù)按照字段升序（A-Z）排列
appkey、idNo 、name、timestamp
2.創(chuàng)建簽名字符串 ：以"key=value" + "&"（連接符）+ "key=value" 的方式連接所有參數(shù)
3.創(chuàng)建簽名：拼接簽名字符串示例string = "appkey=xxxx&idNo =xxxxx&name=張三& timestamp=1614759954"，然后使用sha256(string)創(chuàng)建簽名
注：中文需要使用urlencode處理后再參與創(chuàng)建簽名請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 是否必需 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無(wú) | 三要素應(yīng)用 appid，自控制臺(tái)獲取 |
timestamp | string | 必需 | 無(wú) | 時(shí)間戳 |
name | string | 必需 | 無(wú) | 待驗(yàn)證的身份證姓名 |
idNo | string | 必需 | 無(wú) | 待驗(yàn)證的身份證號(hào)碼 |
signature | string | 必需 | 無(wú) | sha256 數(shù)據(jù)加密校驗(yàn)證書(shū) |
返回參數(shù)格式
jsonString
代碼示例
詳情請(qǐng)查詢demo示例文檔
響應(yīng)消息
API請(qǐng)求失敗
{
// 狀態(tài)描述
'status' : 'error' ,
// API流水號(hào)
'send_id' : "********************************",
// API返回的狀態(tài)碼 詳情查看 API錯(cuò)誤代碼與描述 文檔
'code' : 1201 ,
// API返回的描述
'msg' : 'Incorrect APP ID.' ,
}
{
"status": "error",
"send_id": "********************************",
"code": 1217,
"msg": "API Gateway Error:請(qǐng)檢查身份證號(hào)碼的有效性(*****)"
}
API請(qǐng)求成功
{
"status": "success",
"send_id": "********************************",
"result": {
//身份證號(hào)碼
"bank_idCard": "******************",
//姓名
"bank_name": "***",
//結(jié)果描述
"bank_msg": "驗(yàn)證通過(guò)",
//是否驗(yàn)證一致 01一致 02不一致
"status": "01",
//是否驗(yàn)證一致 true一致 false不一致
"identical": true
}
}
identical和status 參數(shù)意義相同
//認(rèn)證失敗，返回示例
{
"status": "success",
"send_id": "********************************",
"result": {
"bank_idCard": "******************",
"bank_name": "****",
"bank_msg": "驗(yàn)證不通過(guò)",
"status": "02",
"identical": false
}
}