API: Factor/ocr_idcard - 身份證OCR識別
概覽
Factor/ocr_idcard是 submail 的身份證 OCR 識別 API，讀寫身份證圖片上的身份信息。
URL
<主> http://tpa.mysubmail.com/factor/ocr_idcard
<備> https://tpa.mysubmail.com/factor/ocr_idcardhttp 請求方式
| 請求方式 | content-type 設置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
signature創(chuàng)建規(guī)則
1. 請將以下參數(shù)按照字段升序（A-Z）排列 appkey 、timestamp
2. 創(chuàng)建簽名字符串 ：以"key=value" + "&"（連接符）+ "key=value" 的方式連接所有參數(shù)
3. 創(chuàng)建簽名：拼接簽名字符串示例string = "appkey=xxxx×tamp=xxxxxxxxxx"，然后使用sha256(string)創(chuàng)建簽名
注：中文需要使用urlencode處理后再參與創(chuàng)建簽名請求參數(shù)
| 參數(shù) | 類型 | 是否必需 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 身份認證服務中創(chuàng)建并且認證通過的應用 ID |
timestamp | string | 必需 | 無 | UNIX 時間戳 |
signature | string | 必需 | 無 | 簽名，詳細規(guī)則看下方介紹 |
ocr_type | string | 必需 | 無 | 0表示身份證正面，1表示身份證反面 |
file_type | string | 必需 | 無 | 圖片的格式(file / base64)，選擇 file 那邊 base64 參 數(shù)就可為空，反之亦然 |
file | file | 必需 | 無 | 身份證圖片文件 支持 png、jpeg、jpg |
base64 | string | 必需 | 無 | 身份證圖片 BASE64 字符串 |
返回參數(shù)格式
jsonString
代碼示例
詳情請查詢demo示例文檔
響應消息
API請求失敗
{
'status' : 'error' , // 狀態(tài)描述
'send_id' : 'ee05d1635db847a2bf3c8317434539d6', // API流水號
'code' : 1201 , // API返回的狀態(tài)碼 詳情查看 API錯誤代碼與描述 文檔
'msg' : 'Incorrect APP ID.' , // API返回的描述、
}
API請求成功
{
'status' : 'success' , // 狀態(tài)描述
'send_id' : 'ee05d1635db847a2bf3c8317434539d6', // API流水號
'result' : {
'race' => '', //(注:民族(漢字)
'name' => '', //身份證姓名
'gender' => '', //性別
'idCardNumber' => '', //身份證號碼
'birthday' => '', //生日
'address' => '', //地址
'side' => '', //注:front/back 表示身份證的人像面/國徽面
'validDate' => '', //有效日期
'issuedBy' => '', //頒發(fā)機構
};
}