一、接口简介
在数字化时代，快速准确地提取身份证信息变得尤为重要。**万维易源提供的“身份证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接口，为用户提供了便捷、高效的身份信息提取工具。通过这一接口，用户可以快速获取身份证的详细信息，无论是用于身份验证、用户注册还是信息录入，都能极大地提高效率和准确性。**希望本文的介绍能够帮助大家更好地理解和使用这个接口，提升信息处理的效率和体验。如果你有任何疑问或需要进一步的帮助，请随时访问万维易源的官方文档或联系技术支持。
