OCR身份证智能识别接口
更新时间:2026-11-03
该接口将实现,传入身份证正/反面照片,识别照片文字信息并返回,包括姓名、身份证号码、性别、名族、出生年月日、地址、签发机关及有效期等文本信息。
1.功能说明
1.1.该接口适用于:实名注册、身份认证等场景。用户通过提交身份证图片自动完成识别,有效提升用户体验;
1.2.使用该接口,传入身份证照片,扫描识别身份证信息并返回,如果传的是正面照片只返回正面信息,如果传的是反面只返回反面信息。
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/verify/ocrIdCard.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式);
1.5.汉字字符集:UTF-8,请注意参数的大小写;
1.6.图片要求:格式为 JPG(JPEG),BMP,PNG,GIF,TIFF(小写也可以),宽和高大于 8px,小于等于4000px,大小不能超过1MB。
1.2.使用该接口,传入身份证照片,扫描识别身份证信息并返回,如果传的是正面照片只返回正面信息,如果传的是反面只返回反面信息。
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/verify/ocrIdCard.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式);
1.5.汉字字符集:UTF-8,请注意参数的大小写;
1.6.图片要求:格式为 JPG(JPEG),BMP,PNG,GIF,TIFF(小写也可以),宽和高大于 8px,小于等于4000px,大小不能超过1MB。
2.输入参数
| 参数 | 名称 | 类型 | 必须 | 描述 |
| 公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
| photo | 身份证(正/反面)照片 | String | 是 | 1. 图片base64字符串; 2. 该参数长度过大,使用body传参; 3. photo和photoUrl二选一。 |
| photoUrl | 身份证(正/反面)URL地址 | String | 是 |
1. 图片URL地址; 2. photo和photoUrl二选一。 |
3.调用示例
3.1 浏览器测试样例
http(s)://api.guoyangyun.com/api/verify/ocrIdCard.htm?appkey=123456&appsecret=448484484&photo(或photoUrl)=base64字符串/图片URL地址
3.2 请求示例下载
| Curl | Java | C# | PHP | Python | ObjectC |
4.Json返回
4.1.返回参数
| 参数 | 名称 | 类型 | 描述 |
| code | 返回码 | String | 请求结果。0:表示成功,其他:失败。(状态码详见:《OCR错误码对照表》) |
| msg | 信息描述 | String | 返回码对应的中文描述。 |
data |
OCR识别详情 | List | OCR智能识别结果集 |
| responseCode | OCR识别结果 | String | 0:识别成功;其他:识别未成功。可参考错误码对照表查看 |
| responseDesc | 识别结果详细描述 | String | 核验结果描述。可参考错误码对照表查看 |
| side | 身份证正/反面 | String | [front=国徽面],[back=人像面] |
| name | 姓名 | String | 人像面-姓名 |
| gender | 性别 | String | 人像面-性别 |
| nation | 民族 | String | 人像面-民族 |
| birthday | 出生 | String | 人像面-出生日期 |
| address | 住址 | String | 人像面-住址 |
| idCardNo | 公民身份号码 | String | 人像面-公民身份号码 |
| expiredDate | 有效期限 | String | 国徽面-有效期限 |
| issueOrg | 签发机关 | String | 国徽面-签发机关 |
4.2.调用成功样例
{
"code": "0",
"msg": "成功",
"data": {
"side": "back", //身份证正反面 [front=国徽面],[back=人像面]
"name": "张三", //人像面-姓名
"gender": "男", //人像面-性别
"nation": "汉", //人像面-民族
"birthday": "1995-06-19", //人像面-出生
"address": "浙江省杭州市xxxx", //人像面-住址
"idCardNo": "1234567890", //人像面-公民身份号码
"expiredDate": "2026.10.01-2036.10.01", //国徽面-有效期限
"issueOrg": "xx公安局", //国徽面-签发机关
"traceNo": "c6703b273db9484f976a140e5ca38563", //流水号
"responseCode": "0" //0-识别成功,其他可参考错误码对照表查看
"responseDesc": "成功", //识别描述。可参考错误码对照表查看
}
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
"balance": "5"
}
data