身份证识别。
接口说明
本接口适用场景
- 阿里云身份证文字识别，是阿里云官方自研OCR文字识别产品，用于对中国身份证（含临时身份证）正反面图片进行智能文字识别并结构化输出识别结果。
- 阿里云OCR产品基于阿里巴巴达摩院强大的AI技术及海量数据，历经多年沉淀打磨，具有服务稳定、操作简易、实时性高、能力全面等几大优势。
- 本接口图片示例
本接口核心能力
| 分类 | 概述 |
|---|---|
| 多类型覆盖 | 支持自动区分正反面、支持少数民族版式识别、临时身份证识别、生僻字识别、反光实拍、劣质图像识别。 |
| 风险检测 | 支持证件风险检测预警能力，包括智能判断图片完整度、复印件检测、翻拍检测、质量分等。 |
| 人像检测 | 支持图像检测功能，可定位身份证中的人像图案并返回坐标。 |
| 图像增强 | 默认支持图像增强，包括图像自动旋转、畸变自动矫正、模糊图片自动增强等能力。 |
如何使用本接口
| 步骤 | 概述 |
|---|---|
| 1 | 开通 个人证照识别 服务。开通服务前后，您可以通过体验馆免费体验本功能识别效果。 |
| 2 | 购买身份证识别资源包。本API会赠送免费额度，可使用免费额度测试。您也可以不购买资源包，系统会通过“按量付费”方式按实际调用量自动扣款。 |
| 3 | 可以参照调试页面提供的代码示例完成API接入开发。接入完成后，调用API获取识别结果。如果使用子账号调用接口，需要阿里云账号（主账号）对RAM账号进行授权。创建RAM用户的具体操作，请参考：创建RAM用户。文字识别服务提供一种系统授权策略，即AliyunOCRFullAccess。具体授权操作，请参见在用户页面为RAM用户授权。 |
重要提示
| 类型 | 概述 |
|---|---|
| 图片格式 |
|
| 图片尺寸 |
|
| 图片大小 |
|
| 国家与语言 |
|
| 其他提示 |
|
| 相关能力 |
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ocr:RecognizeIdcard | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Url | string | 否 |
| https://img.alicdn.com/tfs/TB1q5IeXAvoK1RjSZFNXXcxMVXa-483-307.jpg |
| body | byte | 否 |
| 图片二进制文件 |
| OutputFigure | boolean | 否 |
| false |
| OutputQualityInfo | boolean | 否 |
| false |
返回参数
返回参数说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 结构化信息，正面为face字段，反面为back字段。 |
| figure | list | 身份证人像面的人脸位置信息（当OutputFigure=true时，返回此字段）。 |
| sliceRect | list | 结构化信息的坐标信息。 |
| prism_keyValueInfo | list | 结构化信息的坐标信息。 |
| ftype | int | 是否为复印件（1：是，0：否）。 |
| warning | object | 身份证质量检测信息（当OutputQualityInfo=true时，返回此字段）。 |
| angle | int | 图片的角度，0表示正向，90表示图片朝右，180朝下，270朝左。 |
| height | int | 算法矫正图片后的高度。 |
| width | int | 算法矫正图片后的宽度。 |
| orgHeight | int | 原图的高度。 |
| orgWidth | int | 原图的宽度。 |
正面识别结果（face字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| name | string | 姓名。 |
| sex | string | 性别。 |
| ethnicity | string | 民族。 |
| birthDate | string | 出生日期。 |
| address | string | 住址。 |
| idNumber | string | 身份证号码。 |
反面识别结果（back字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| issueAuthority | string | 签发机关。 |
| validPeriod | string | 有效期限。 |
结构化坐标信息（prism_keyValueInfo字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| key | string | 识别出的字段名称。 |
| keyProb | int | 字段名称置信度。 |
| value | string | 识别出的字段名称对应的值。 |
| valueProb | int | 字段名称对应值的置信度。 |
| valuePos | list | 字段在原图中的四个点坐标（左上、右上、右下、左下）。 |
正面人像位置信息（figure字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| type | string | 图案类型。 |
| x | int | 人像图案左上角横坐标。 |
| y | int | 人像图案左上角纵坐标。 |
| w | int | 人像图案宽度。 |
| h | int | 人像图案高度。 |
| box | object | 人像图案坐标信息：人像图案中心横纵坐标，长宽，图案顺时针旋转角度。定义同 OpenCV 中 RotatedRect，请参见 OpenCV 文档。 |
| points | list | 人像图案四个点坐标（左上、右上、右下、左下）。 |
身份证质量检测识别结果（warning字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| isCopy | int | 是否是复印件（1：是，0：否）。 |
| isReshoot | int | 是否是翻拍（1：是，0：否）。 |
| completenessScore | float | 完整度评分。 |
| qualityScore | float | 整体质量分数。 |
示例
正常返回示例
JSON格式
{
"RequestId": "86B83935-DD36-195B-B6E4-D07BE370C8B6",
"Data": "{\"algo_version\": \"b8d33b31ac37b5444dbfe791105de25acb0abba5\", \"data\": {\"face\": {\"algo_version\": \"b8d33b31ac37b5444dbfe791105de25acb0abba5\", \"angle\": 0, \"data\": {\"name\": \"方大呆\", \"sex\": \"女\", \"ethnicity\": \"汉\", \"birthDate\": \"2006年10月2日\", \"address\": \"上海市西藏南路-瞿溪路弘辉名苑\", \"idNumber\": \"371002200610020000\"}, \"figure\": [{\"type\": \"face\", \"x\": 284, \"y\": 24, \"w\": 177, \"h\": 213, \"box\": {\"x\": 371, \"y\": 130, \"w\": 209, \"h\": 172, \"angle\": 89}, \"points\": [{\"x\": 286, \"y\": 27}, {\"x\": 457, \"y\": 25}, {\"x\": 459, \"y\": 234}, {\"x\": 286, \"y\": 230}]}], \"ftype\": 0, \"height\": 307, \"orgHeight\": 307, \"orgWidth\": 483, \"prism_keyValueInfo\": [{\"key\": \"name\", \"keyProb\": 100, \"value\": \"方大呆\", \"valuePos\": [{\"x\": 82, \"y\": 40}, {\"x\": 142, \"y\": 40}, {\"x\": 142, \"y\": 60}, {\"x\": 82, \"y\": 60}], \"valueProb\": 100}, {\"key\": \"sex\", \"keyProb\": 100, \"value\": \"女\", \"valuePos\": [{\"x\": 85, \"y\": 77}, {\"x\": 104, \"y\": 77}, {\"x\": 104, \"y\": 96}, {\"x\": 85, \"y\": 96}], \"valueProb\": 100}, {\"key\": \"ethnicity\", \"keyProb\": 100, \"value\": \"汉\", \"valuePos\": [{\"x\": 192, \"y\": 75}, {\"x\": 212, \"y\": 75}, {\"x\": 212, \"y\": 95}, {\"x\": 192, \"y\": 95}], \"valueProb\": 100}, {\"key\": \"birthDate\", \"keyProb\": 100, \"value\": \"2006年10月2日\", \"valuePos\": [{\"x\": 76, \"y\": 116}, {\"x\": 214, \"y\": 116}, {\"x\": 214, \"y\": 131}, {\"x\": 76, \"y\": 131}], \"valueProb\": 100}, {\"key\": \"address\", \"keyProb\": 100, \"value\": \"上海市西藏南路-瞿溪路弘辉名苑\", \"valuePos\": [{\"x\": 73, \"y\": 154}, {\"x\": 278, \"y\": 154}, {\"x\": 278, \"y\": 196}, {\"x\": 73, \"y\": 196}], \"valueProb\": 100}, {\"key\": \"idNumber\", \"keyProb\": 100, \"value\": \"371002200610020000\", \"valuePos\": [{\"x\": 162, \"y\": 256}, {\"x\": 379, \"y\": 256}, {\"x\": 379, \"y\": 274}, {\"x\": 162, \"y\": 274}], \"valueProb\": 100}], \"sliceRect\": {\"x0\": 0, \"y0\": 0, \"x1\": 482, \"y1\": 0, \"x2\": 483, \"y2\": 307, \"x3\": 0, \"y3\": 307}, \"warning\": {\"isCopy\": 0, \"isReshoot\": 0, \"completenessScore\": 98.645515, \"qualityScore\": 73.324371}, \"width\": 483}}, \"height\": 307, \"orgHeight\": 307, \"orgWidth\": 483, \"width\": 483}",
"Code": "如果识别成功，不会返回此字段）",
"Message": "如果识别成功，不会返回此字段）"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2021-08-17 | OpenAPI 入参发生变更 | |||||
|