認證服務(wù)
號碼檢測
短信服務(wù)
OCR服務(wù)
公共數(shù)據(jù)
1.接口說明
| 名稱 | 說明 |
|---|---|
| 協(xié)議 | HTTPS POST |
| 地址 | https://api.cxlnk.com/api/idCardOcr |
| Accept | application/json |
| Content-Type | application/json;charset=utf-8 |
2.請求參數(shù)說明
響應(yīng) body 數(shù)據(jù)為 JSON 格式
| 列表 | 內(nèi)容 | 備注 |
|---|---|---|
| accessKey | API調(diào)用賬號(必填,String類型,從燦星云平臺獲?。?/td> | |
| accessSecret | API調(diào)用密鑰(必填,String類型,從燦星云平臺獲?。?/td> | |
| image | 人臉照(必填) | 身份證識別的照片,說明:imageType 為 BASE64 時,傳入照片的 base64 字符編碼,base64 字符串不包含 data:image前綴,圖片類型建議 jpg 格式,建議 1M 以內(nèi)。圖片大小不能大于 2M |
| imageType | 圖片類型(必填) | 圖片類型,枚舉值:URL-圖片路徑 ,BASE64 –圖片 BASE64 編碼 |
| ocrType | ocr類型(必填) | 區(qū)分身份證正反面參數(shù)(ocrType=0 為正面;ocrType=1 為反面) |
| detectRisk | 是否開啟身份證風險類型 | 是否開啟身份證風險類型(身份證復印件)功能,默認不開啟,即:false??蛇x值:true-開啟;false-不開啟 |
3.請求參數(shù)示例
{
"accessKey": "NDYw*******",
"accessSecret": "MDQyOTQ1OTM3*********************",
"imageType":"BASE64",
"image":"DAQL/xAA+EAACAgEEAAUCAwYD***************",
"ocrType":"0",
"detectRisk":"false"
}
4.響應(yīng)參數(shù)列表
| 列表 | 內(nèi)容 |
|---|---|
| code | 狀態(tài)碼200則為成功 |
| msg | 狀態(tài)說明 |
| success | 處理是否成功:取值范圍 true,false |
| data | 業(yè)務(wù)數(shù)據(jù) 如果失敗則為空 |
| +address | 身份證上地址(僅ocrType為0時返回) |
| +nation | 身份證上民族(僅ocrType為0時返回) |
| +tradeNo | 交易流水號 |
| +fee | 是否扣費 0不收費1收費 |
| +issuingDate | 簽發(fā)日期(僅ocrType為1時返回) |
| +issuingDate | 簽發(fā)日期(僅ocrType為1時返回) |
| +sex | 身份證上性別(僅ocrType為0時返回) |
| +birth | 身份證上出生日期(僅ocrType為0時返回) |
| +imageStatus | 圖像狀態(tài),normal-識別正常,reversed_side-身份證正反面顛倒,non_idcard-上傳的圖片中不包含身份證,blurred-身份證模糊,not_complete-身份證不完整,over_dark-欠曝,over_exposure-過曝,unknown-未知狀態(tài) |
| +expiryDate | 有效日期(僅ocrType為1時返回) |
| +issuingAuthority | 簽發(fā)機關(guān)(僅ocrType為1時返回) |
| +cardNum | 身份證編號(僅ocrType為0時返回) |
| +name | 身份證上姓名(僅ocrType為0時返回) |
| +direction | 圖像方向 -1-未定義,0-正向,1-逆時針90度,2-逆時針180度,3-逆時針270度 |
| +riskType | 身份證風險類型,輸入?yún)?shù)detect_risk=true時,則返回該字段識別身份證類型,normal-正常身份證,copy-復印件 |
5.響應(yīng)參數(shù)示例
{
"code": 200,
"msg": "成功",
"success": true,
"data":{
"tradeNo":"交易流水號",
"address":"地址",
"birth":"出生日期",
"name":"姓名",
"cardNum":"身份證編號",
"sex":"性別",
"nation":"民族",
"imageStatus":"圖像狀態(tài)",
"riskType":"身份證風險類型",
"direction":"圖像方向"
}
}
6.結(jié)果碼說明
| 結(jié)果碼 | 描述 |
|---|---|
| 200 | 成功 |
| 500,501,503 | 系統(tǒng)錯誤 |
| 502 | 系統(tǒng)繁忙 |
| 60021 | 余額不足,請充值后重試! |
| 10000 | 內(nèi)部系統(tǒng)出錯,請聯(lián)系廠商 |