API: Factor/detail - 詳版運營商三要素
概覽
? factor/detail
是 SUBMAIL 的詳版身份驗證 API,可以根據(jù)身份證號碼、手機號碼和姓名判斷三者是否一致,并獲取部分運營商相關信息。
URL
<主> http://tpa.mysubmail.com/factor/detail
<備> https://tpa.mysubmail.com/factor/detail
http 請求方式
請求方式 | content-type 設置 |
---|---|
http post | multipart/form-data 、x-www-form-urlencoded 、application/json |
signature創(chuàng)建規(guī)則
1.請將以下參數(shù)按照字段升序(A-Z)排列
appkey、idNo 、mobile、name、timestamp
2.創(chuàng)建簽名字符串 :以"key=value" + "&"(連接符)+ "key=value" 的方式連接所有參數(shù)
3.創(chuàng)建簽名:拼接簽名字符串示例string = "appkey=xxxx&idNo=xxxx&mobile=188xxxx&name=張三& timestamp=1614759954",然后使用sha256(string)創(chuàng)建簽名
注:中文需要使用urlencode處理后再參與創(chuàng)建簽名
請求參數(shù)
參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 無 | 三要素appid,自控制臺獲取 |
timestamp | string | 必需 | 無 | 時間戳 |
name | string | 必需 | 無 | 待驗證的身份證姓名 |
idNo | string | 必需 | 無 | 待驗證的身份證號碼 |
mobile | string | 必需 | 無 | 待驗證的號碼 |
signature | string | 必需 | 無 | sha256 加密校驗數(shù)字證書 |
返回參數(shù)格式
jsonString
代碼示例
詳情請查詢demo示例文檔
響應消息
API請求失敗
{
// 狀態(tài)描述
'status' : 'error' ,
// API流水號
'send_id' : "********************************",
// API返回的狀態(tài)碼 詳情查看 API錯誤代碼與描述 文檔
'code' : 1217 ,
// API返回的描述
'msg' : 'Incorrect APP ID.' ,
}
{
"status": "error",
"send_id": "********************************",
"code": 1217,
"msg": "API Gateway Error:身份證格式錯誤(****)"
}
API請求成功
{
"status": "success",
"send_id": "********************************",
"result": {
//true 一致 false 不一致
"identical": true,
//01 一致 02 不一致
"status": "01",
//運營商編碼 1中國移動 2中國聯(lián)通 3中國電信 0查詢失敗
"ope_type": 2,
//運營商中文名稱
"provider": "中國聯(lián)通",
//返回結果描述
"msg": "一致",
}
}
identical和status 參數(shù)意義相同
//認證不一致
{
"status": "success",
"send_id": "********************************",
"result": {
"identical": false,
"status": "02",
"ope_type": "2",
"provider": "中國聯(lián)通"
"msg": "認證不一致,手機號匹配成功,姓名匹配失敗,身份證匹配失敗",
}
}
錯誤代碼
? 參閱 API 錯誤代碼