识别文件中的身份证

身份证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。 文件大小需要小于10M。

Tip: 单租户限流：10QPS，同租户下的应用没有限流，共享本租户的 10QPS 限流

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/document_ai/v1/id_card/recognize
HTTP Method	POST
接口频率限制	10 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	document_ai:id_card:recognize 身份证识别

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	示例值："multipart/form-data; boundary=---7MA4YWxkTrZu0gW"

请求体

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

请求体示例

---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	识别的字段种类 可选值有： - identity_code: 公民身份号码 - identity_name: 姓名 - address: 住址 - valid_date_start: 有效期起始时间 - valid_date_end: 有效期终止时间（“长期”识别为“长期”） - gender: 性别 - race: 民族 - issued_by: 签发机关 - birth: 出生日期
└ value	string	识别出字段的文本信息
└ side	int	正反面，1为身份证-姓名页，0为身份证-国徽页
└ conners	int\[\]	四角坐标[x0,y0,x1,y1,x2,y2,x3,y3]

响应体示例

{
    "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.	智能文档解析次数已达使用上限，如需继续使用，请联系销售购买