一、接口簡介
在數字化時代，快速準確地提取身份證信息變得尤為重要。**萬維易源提供的“身份證OCR識別”API接口，能夠快速提取二代居民身份證正反面的所有字段信息，包括姓名、性別、民族、出生日期、住址、身份證號、簽發機關、有效期限等。**這一接口廣泛應用于身份驗證、用戶注冊、信息錄入等場景，極大地提高了信息處理的效率和準確性。本文將詳細介紹如何使用這個API接口。
二、接口地址
https://route.showapi.com/1429-1?appKey={your_appKey}
請將 {your_appKey} 替換為你在萬維易源平臺申請的個人 appKey。
三、接口參數
（一）請求參數
以下是提交身份證base64圖片信息查詢任務所需的請求參數：
| 參數名稱 | 類型 | 示例值 | 是否必須 | 描述 |
|---|---|---|---|---|
| imgData | String | 否 | 身份證圖片的base64信息，建議圖片小于1.5M，imgData和imgUrl必須選一個作為圖片的入參方式 | |
| type | String | 否 | 身份證的正面或反面，正面1 反面2，不填我們可以自動識別 | |
| imgUrl | String | https://showapi.oss-cn-hangzhou.aliyuncs.com/test/sfzbm.jpg | 否 | 身份證圖片的URL，建議圖片小于1.5M，imgData和imgUrl必須選一個作為圖片的入參方式 |
| needQuality | String | 1 | 否 | 是否需要返回圖片屬性檢測，1表示需要，0表示不需要 |
（二）返回參數
以下是接口返回的參數及其描述：
| 參數名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| name | String | 王XX | 姓名 |
| sex | String | 男 | 性別 |
| nationality | String | 漢 | 民族 |
| birthday | String | 198X-0X-XX | 生日 |
| addr | String | 湖北省武漢市… | 地址 |
| idNo | String | *********01211122 | 身份證號碼 |
| headImgBase64 | String | 若需要該字段值請使用身份證識別返照接口 | 身份證圖像的base64（若需要該字段值請使用身份證識別返照接口） |
| depInfo | String | 簽發部門（國徽面才返回該字段） | |
| effDate | String | 有效期的起始日期（國徽面才返回該字段）格式：yyyy-MM-dd | |
| effBeginDate | String | 簽發日期（國徽面才返回該字段）格式：yyyy-MM-dd | |
| effEndDate | String | 有效期的截止日期（國徽面才返回該字段）格式：yyyy-MM-dd，可能返回“長期有效”字樣 | |
| ret_code | String | 0 | 接口調用是否成功，0為成功，其他為失敗 |
| flag | String | true | 業務識別是否成功，false時，沒有識別出的業務字段返回，只有錯誤信息返回 |
| msg | String | 識別成功! | 提示信息 |
| quality | String[] | [“photo”] | 圖片屬性檢測結果，需要入參needQuality為1才有該字段返回。shoot表示可能為翻拍，photo表示正式身份證，temporary表示為臨時身份證，edited表示圖片可能經過圖片編輯軟件的編輯，copy表示可能為復印件 |
四、調用示例
（一）請求示例
以下是使用curl命令調用該API接口的示例：
curl 'https://route.showapi.com/1429-1?appKey=your_appKey' \-H 'Content-Type: application/x-www-form-urlencoded' \-d 'needQuality=1' \-d 'imgData=' \-d 'type=' \-d 'imgUrl=https%3A%2F%2Fshowapi.oss-cn-hangzhou.aliyuncs.com%2Ftest%2Fsfzbm.jpg'
請將 your_appKey 替換為你在萬維易源平臺申請的 appKey。
（二）返回示例
調用成功后，接口會返回如下格式的JSON數據：
{"showapi_res_code": 0,"showapi_res_error": "","showapi_res_id": "ce135f6739294c63be0c021b76b6fbff","showapi_res_body": {"msg": "識別成功!","birthday": "198X-0X-XX","flag": true,"nationality": "漢","sex": "男","quality": ["photo"],"name": "王XX","headImgBase64": "若需要該字段值請使用身份證識別返照接口","addr": "湖北省武漢市.....","ret_code": 0,"idNo": "*********01211122"}
}
五、注意事項
- 確保圖片質量：輸入的身份證圖片應清晰、完整，避免模糊、反光或遮擋，以提高識別準確率。
- 合理選擇入參方式：
imgData和imgUrl必須選一個作為圖片的入參方式，建議優先使用imgData，以減少網絡延遲。 - 處理異常情況：根據返回的
ret_code和msg，及時處理識別失敗等情況，確保接口調用的穩定性和可靠性。 - 遵守使用規范：合理控制調用頻率，避免惡意調用行為，如短時間內重復提交相同的圖片。
六、總結
**萬維易源提供的“身份證OCR識別”API接口，為用戶提供了便捷、高效的身份信息提取工具。通過這一接口，用戶可以快速獲取身份證的詳細信息，無論是用于身份驗證、用戶注冊還是信息錄入，都能極大地提高效率和準確性。**希望本文的介紹能夠幫助大家更好地理解和使用這個接口，提升信息處理的效率和體驗。如果你有任何疑問或需要進一步的幫助，請隨時訪問萬維易源的官方文檔或聯系技術支持。
