包括全国主要省市健康码，支持健康码图片的姓名、日期、时间、颜色、备注信息等主要字段的识别结果输出。
接口说明
本接口适用场景
- 阿里云防疫健康码识别，是阿里云官方自研 OCR 文字识别产品，适用于获取健康码上的健康码颜色、姓名、日期等关键信息的场景。
- 阿里云 OCR 产品基于阿里巴巴达摩院强大的 AI 技术及海量数据，历经多年沉淀打磨，具有服务稳定、操作简易、实时性高、能力全面等几大优势。
- 本接口图片示例
本接口核心能力
| 分类 | 概述 |
|---|---|
| 图像增强 | 默认支持图像增强，包括图像自动旋转、畸变自动矫正、模糊图片自动增强等能力。 |
| 全字段识别 | 智能识别营业执照上所包含的全部字段。 |
| 多类型覆盖 | 支持模糊、光照不均、透视畸变、任意背景等低质量图像识别。 |
| 高精度识别 | 识别准确率可达 98%。 |
如何使用本接口
| 步骤 | 概述 |
|---|---|
| 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:RecognizeHealthCode | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Url | string | 否 |
| https://img.alicdn.com/imgextra/i3/O1CN01ME0L7j29f6VRZKo5e_!!6000000008094-0-tps-1237-1981.jpg |
| body | byte | 否 |
| 图片二进制文件 |
返回参数
返回参数说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 结构化信息，正面为 face 字段，反面为 back 字段。 |
| sliceRect | list | 结构化信息的坐标信息。 |
| prism_keyValueInfo | list | 结构化信息的坐标信息。 |
| ftype | int | 是否为复印件（1：是，0：否）。 |
| angle | int | 图片的角度，0 表示正向，90 表示图片朝右，180 朝下，270 朝左。 |
| height | int | 算法矫正图片后的高度。 |
| width | int | 算法矫正图片后的宽度。 |
| orgHeight | int | 原图的高度。 |
| orgWidth | int | 原图的宽度。 |
结构化信息（data 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| name | string | 姓名。 |
| idNumber | string | 证件号码。 |
| date | string | 日期。 |
| time | string | 时间。 |
| color | string | 颜色。 |
| remarks | string | 备注信息。 |
结构化坐标信息（prism_keyValueInfo 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| key | string | 识别出的字段名称。 |
| keyProb | int | 字段名称置信度。 |
| value | string | 识别出的字段名称对应的值。 |
| valueProb | int | 字段名称对应值的置信度。 |
| valuePos | list | 字段在原图中的四个点坐标（左上、右上、右下、左下）。 |
示例
正常返回示例
JSON格式
{
"RequestId": "43A29C77-405E-4CC0-BC55-EE694AD00655",
"Data": "{\"data\": {\"name\": \"读小光\", \"idNumber\": \"*********83X\", \"date\": \"03-30\", \"time\": \"05:58:03\", \"color\": \"绿色\", \"remarks\": \"绿色:勤洗手、常通风、戴口罩,出现发热咳嗽等症状请及时就医\"}, \"ftype\": 0, \"height\": 1981, \"orgHeight\": 1981, \"orgWidth\": 1237, \"prism_keyValueInfo\": [{\"key\": \"name\", \"keyProb\": 100, \"value\": \"读小光\", \"valuePos\": [{\"x\": 153, \"y\": 213}, {\"x\": 154, \"y\": 155}, {\"x\": 311, \"y\": 157}, {\"x\": 310, \"y\": 216}], \"valueProb\": 100}, {\"key\": \"idNumber\", \"keyProb\": 100, \"value\": \"*********83X\", \"valuePos\": [{\"x\": 785, \"y\": 152}, {\"x\": 1209, \"y\": 150}, {\"x\": 1209, \"y\": 213}, {\"x\": 786, \"y\": 215}], \"valueProb\": 100}, {\"key\": \"date\", \"keyProb\": 100, \"value\": \"03-30\", \"valuePos\": [{\"x\": 516, \"y\": 470}, {\"x\": 516, \"y\": 577}, {\"x\": 179, \"y\": 577}, {\"x\": 179, \"y\": 470}], \"valueProb\": 100}, {\"key\": \"time\", \"keyProb\": 100, \"value\": \"05:58:03\", \"valuePos\": [{\"x\": 1053, \"y\": 470}, {\"x\": 1054, \"y\": 574}, {\"x\": 540, \"y\": 576}, {\"x\": 539, \"y\": 472}], \"valueProb\": 100}, {\"key\": \"color\", \"keyProb\": 16, \"value\": \"绿色\", \"valuePos\": [{\"x\": 91, \"y\": 1473}, {\"x\": 1112, \"y\": 1469}, {\"x\": 1113, \"y\": 1560}, {\"x\": 92, \"y\": 1563}], \"valueProb\": 100}, {\"key\": \"remarks\", \"keyProb\": 100, \"value\": \"绿色:勤洗手、常通风、戴口罩,出现发热咳嗽等症状请及时就医\", \"valuePos\": [{\"x\": 91, \"y\": 1473}, {\"x\": 1112, \"y\": 1469}, {\"x\": 1113, \"y\": 1560}, {\"x\": 92, \"y\": 1563}], \"valueProb\": 100}], \"sliceRect\": {\"x0\": 0, \"y0\": 0, \"x1\": 1237, \"y1\": 0, \"x2\": 1233, \"y2\": 1981, \"x3\": 0, \"y3\": 1981}, \"width\": 1237}",
"Code": "noPermission",
"Message": "You are not authorized to perform this operation."
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-04-26 | 新增 OpenAPI | 查看变更详情 |
SDK 调用 通过 SDK 调用此接口的示例请参考开发者中心