# 识别文件中的身份证

身份证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
文件大小需要小于10M。
**注意事项**：单租户限流：10QPS，同租户下的应用没有限流，共享本租户的 10QPS 限流

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/document_ai/v1/id_card/recognize
HTTP Method | POST
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 身份证识别(document_ai:id_card:recognize)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **示例值**："multipart/form-data; boundary=---7MA4YWxkTrZu0gW"

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
file | file | 是 | 识别身份证的源文件<br>**示例值**：file binary

### 请求体示例

```HTTP
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file";
Content-Type: application/octet-stream

---7MA4YWxkTrZu0gW
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
id_card | id_card | 身份证信息
entities | id_entity\[\] | 识别的实体列表
type | string | 识别的字段种类<br>**可选值有**：<br>- identity_code：公民身份号码<br>- identity_name：姓名<br>- address：住址<br>- valid_date_start：有效期起始时间<br>- valid_date_end：有效期终止时间（“长期”识别为“长期”）<br>- gender：性别<br>- race：民族<br>- issued_by：签发机关<br>- birth：出生日期
value | string | 识别出字段的文本信息
side | int | 正反面，1为身份证-姓名页，0为身份证-国徽页
conners | int\[\] | 四角坐标[x0,y0,x1,y1,x2,y2,x3,y3]

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "id_card": {
            "entities": [
                {
                    "type": "identity_name",
                    "value": "张三"
                }
            ],
            "side": 0,
            "conners": [
                0
            ]
        }
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 2110001 | param is invalid | 输入文件错误，参考文档检查输入参数
400 | 2110002 | no valid entity | 未检测出身份证信息，参考文档检查输入文件是否有效
500 | 2110010 | internal error, please try later | 后端服务异常或网络异常，可重新请求
400 | 2110003 | You have reached the Intelligent document parsing limit. To continue using this function, please contact sales to purchase more. | 智能文档解析次数已达使用上限，如需继续使用，请联系销售购买