# 身份证OCR识别 · 身份证信息识别

> 本文档为机器可读 Markdown，便于 AI / SDK 自动对接。页面原文：https://www.wapi.cn/api_detail/76/194.html
> 纯文本地址：`https://www.wapi.cn/api_detail/76/194.html?format=md`

## 概览

- **接口名称**：身份证信息识别
- **子接口**：身份证OCR识别（ID `194`）
- **接口简介**：身份证信息识别服务可以自动地从图片中定位身份证图片区域，识别出其中包含的身份信息。
- **计费说明**：按次
- **请求地址**：`https://uaqy.api.storeapi.net/pyi/76/194`（支持 http/https）
- **请求方式**：`POST`
- **返回格式**：`json,xml`
- **Content-Type（POST）**：`application/x-www-form-urlencoded;charset=utf-8`

## 请求参数

| 名称 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `appid` | 是 | String | 应用ID，在后台我的应用查看或者添加 | 1 |
| `ascii` | 否 | String | 将json字符串中的中文字符使用Unicode编码 | true |
| `format` | 否 | String | 返回数据格式类型，每个接口已经说明支持返回格式:json,xml, jsonp调用方法说明 | json |
| `id_card_side` | 是 | String | -front：身份证含照片的一面 -back：身份证带国徽的一面 自动检测身份证正反面，如果传参指定方向与图片相反，支持正常识别，返回参数image_status字段为"reversed_side" |  |
| `sign` | 是 | String | 1.使用Md5方式验证，参数按一定规则md5后返回的字符串，详情点击这里阅读 2.使用Hash验证方式，直接跟上密钥即可。如何设置hash验证 通过我的应用里面修改验证方式 | 52a9dbe274a5c537bbf7a53e2d66c09f |
| `time` | 否 | String | 请求时传递的当前服务器时间戳 | 1545829466 |
| `url_image` | 否 | String | 行驶证图片URL(同driving_license_url) |  |

## 签名（MD5）

按参数名排序后拼接「键名+值」，空值不参与；末尾直接追加 32 位密钥（密钥不写键名）：

```
sign = MD5(appid1asciitrueformatjsontime1545829466{secret})
```

说明：示例中 `appid` 默认为 `1`，请替换为「我的应用」中的 appid；密钥为应用 Secret。

## 返回参数

| 名称 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `codeid` | 否 | Integer | 状态码，返回10000状态都会进行计费。具体说明可查看状态码说明 | 10000 |
| `idcard_number_type` | 否 | Integer | 用于校验身份证号码、性别、出生是否一致，输出结果及其对应关系如下： -1: 身份证正面所有字段全为空 0: 身份证证号不合法，此情况下不返回身份证证号 1: 身份证证号和性别、出生信息一致 2: 身份证证号和性别、出生信息都不一致 3: 身份证证号和出生信息不一致 4: 身份证证号和性别信息不一致 | 1 |
| `image_status` | 否 | String | normal-识别正常 reversed_side-身份证正反面颠倒 non_idcard-上传的图片中不包含身份证 blurred-身份证模糊 other_type_card-其他类型证照 over_exposure-身份证关键字段反光或过曝 over_dark-身份证欠曝（亮度过低） unknown-未知状态 | reversed_side |
| `message` | 否 | String | 请求状态说明 | 识别成功 |
| `retdata` | 否 | Array | 回数据集合,可能是数据、对象或者字符串 |  |
| `time` | 否 | String | 请求时传递的当前服务器时间戳 | 1614930150 |
| `住址` | 否 | String |  | 江西省抚州市广昌县 |
| `公民身份号码` | 否 | String |  | 362532199404064129 |
| `出生` | 否 | String |  | 19940406 |
| `失效日期` | 否 | String |  | 20370313 |
| `姓名` | 否 | String |  | 李义 |
| `性别` | 否 | String |  | 男 |
| `民族` | 否 | String |  | 汉 |
| `签发日期` | 否 | String |  | 20170313 |
| `签发机关` | 否 | String |  | 广昌县公安局 |

## JSON 返回示例

```json
{
    "codeid": "10000",
    "message": "识别成功",
    "retdata": {
        "image_status": "reversed_side",
        "idcard_number_type": 1,
        "姓名": "李义",
        "民族": "汉",
        "住址": "江西省抚州市广昌县",
        "公民身份号码": "362532199404064129",
        "出生": "19940406",
        "性别": "男",
        "失效日期": "20370313",
        "签发机关": "广昌县公安局",
        "签发日期": "20170313"
    },
    "time": 1614930150
}
```

## 状态码说明

| 状态码 | 说明 |
| --- | --- |
| `10000` | 返回成功 |
| `10001` | appid必须指定，可以我的应用里面查看 |
| `10002` | sign值必须指定，加密规则请前往帮助中心查看 |
| `10003` | sign值验证不通过，加密规则请前往帮助中心查看 |
| `10004` | 时差不能超过10分钟，可以不传递这个参数，注意时间戳单位是秒 |
| `10005` | appid错误，请检查appid值,前往会员中心->我的应用查看或添加 |
| `10006` | 当前IP地址未授权，请前往用户中心->我的应用添加ip{@info} |
| `10007` | 应用被禁用，请联系客服处理 |
| `10008` | 应用内没有该接口，请到我的应用里面添加这个接口 |
| `10009` | api接口不存在 |
| `10010` | 您没有添加该api接口 |
| `10011` | api已经到期 |
| `10012` | 没有订购任何api,请前往购买后再操作 |
| `10013` | 该接口已经暂停使用 |
| `10014` | 未知的错误，可以联系客服处理 |
| `10015` | 参数个数错误 |
| `10019` | {@info} |
| `10017` | time必须是整型 |
| `10018` | 次数不足 |
| `10020` | 子接口不存在,可能已经被关闭 |
| `10021` | 服务器发生错误 |
| `10022` | 帐户余额不足，请充值！ |
| `10023` | 订单提交成功，等待回调结果 |
| `10024` | 调试模式数据 |
| `10025` | 查无数据 |

## 对接提示

1. 先在挖数据（wapi.cn）创建应用，获取 `appid` 与密钥。
2. 按上方参数组装请求，计算 `sign` 后调用接口地址。
3. 可用在线测试工具：`https://www.wapi.cn/api_debug/76/194.html`