支持香港永久性居民身份证和香港居民身份证两种类型的证件识别，已支持全字段识别，包括中文姓名（如有）、英文姓名、中文姓名电码（如有）、出生日期、性别、符号标记、身份证号码等。
接口说明
如何使用本接口
| 步骤 | 概述 |
|---|---|
| 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:RecognizeHKIdcard | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Url | string | 否 |
| https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20241223/bomzne/%E4%B8%AD%E5%9B%BD%E9%A6%99%E6%B8%AF%E8%BA%AB%E4%BB%BD%E8%AF%81%E8%AF%86%E5%88%AB.png |
| body | byte | 否 |
| 图片二进制文件 |
返回参数
返回参数说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 结构化信息。 |
| figure | list | 身份证人像面的人脸位置信息。 |
| sliceRect | list | 结构化信息的坐标信息。 |
| prism_keyValueInfo | list | 结构化信息的坐标信息。 |
| ftype | int | 是否为复印件（1：是，0：否）。 |
| height | int | 算法矫正图片后的高度。 |
| width | int | 算法矫正图片后的宽度。 |
| orgHeight | int | 原图的高度。 |
| orgWidth | int | 原图的宽度。 |
结构化信息（data 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| birthDate | string | 出生日期。 |
| firstIssuedDate | string | 首次签发日期。 |
| idNumber | string | 身份证号码。 |
| issuedCode | string | 签发标志。 |
| issuedDate | string | 签发日期。 |
| nameCn | string | 中文姓名。 |
| nameCode | string | 姓名电码。 |
| nameEn | string | 英文姓名。 |
| sex | 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 | 人像图案四个点坐标（左上、右上、右下、左下）。 |
示例
正常返回示例
JSON格式
{
"RequestId": "43A29C77-405E-4CC0-BC55-EE694AD00655",
"Data": {
"algo_version": "5e7c3de7fb3969700828bd933ee071782bc22088",
"data": {
"birthDate": "01-01-19XX",
"firstIssuedDate": "(01-79)",
"idNumber": "CXXXXXX(E)",
"issuedCode": "***AZ",
"issuedDate": "XX-09-03",
"nameCn": "李XX",
"nameCode": "2621 2535 5174",
"nameEn": "LEE, Chi Nan",
"sex": "女F"
},
"ftype": 0,
"height": 158,
"orgHeight": 158,
"orgWidth": 249,
"prism_keyValueInfo": [
{
"key": "nameCn",
"keyProb": 100,
"value": "李XX",
"valuePos": [
{
"x": 11,
"y": 27
},
{
"x": 53,
"y": 27
},
{
"x": 53,
"y": 40
},
{
"x": 11,
"y": 40
}
],
"valueProb": 100
},
{
"key": "nameEn",
"keyProb": 97,
"value": "LEE, XX",
"valuePos": [
{
"x": 10,
"y": 40
},
{
"x": 81,
"y": 40
},
{
"x": 81,
"y": 51
},
{
"x": 10,
"y": 51
}
],
"valueProb": 97
},
{
"key": "nameCode",
"keyProb": 100,
"value": "XXX",
"valuePos": [
{
"x": 73,
"y": 54
},
{
"x": 155,
"y": 54
},
{
"x": 155,
"y": 64
},
{
"x": 73,
"y": 64
}
],
"valueProb": 100
},
{
"key": "birthDate",
"keyProb": 100,
"value": "01-01-19XX",
"valuePos": [
{
"x": 73,
"y": 86
},
{
"x": 133,
"y": 85
},
{
"x": 133,
"y": 93
},
{
"x": 74,
"y": 95
}
],
"valueProb": 100
},
{
"key": "sex",
"keyProb": 98,
"value": "女F",
"valuePos": [
{
"x": 153,
"y": 84
},
{
"x": 171,
"y": 84
},
{
"x": 171,
"y": 94
},
{
"x": 153,
"y": 94
}
],
"valueProb": 98
},
{
"key": "issuedCode",
"keyProb": 99,
"value": "***AZ",
"valuePos": [
{
"x": 75,
"y": 97
},
{
"x": 104,
"y": 97
},
{
"x": 104,
"y": 106
},
{
"x": 75,
"y": 106
}
],
"valueProb": 99
},
{
"key": "firstIssuedDate",
"keyProb": 100,
"value": "(01-79)",
"valuePos": [
{
"x": 74,
"y": 119
},
{
"x": 115,
"y": 118
},
{
"x": 115,
"y": 126
},
{
"x": 75,
"y": 128
}
],
"valueProb": 100
},
{
"key": "issuedDate",
"keyProb": 100,
"value": "15-09-03",
"valuePos": [
{
"x": 74,
"y": 135
},
{
"x": 133,
"y": 133
},
{
"x": 133,
"y": 143
},
{
"x": 75,
"y": 144
}
],
"valueProb": 100
},
{
"key": "idNumber",
"keyProb": 100,
"value": "XXXXXX(E)",
"valuePos": [
{
"x": 160,
"y": 134
},
{
"x": 232,
"y": 133
},
{
"x": 232,
"y": 142
},
{
"x": 161,
"y": 144
}
],
"valueProb": 100
}
],
"sliceRect": {
"x0": 0,
"x1": 248,
"x2": 248,
"x3": 0,
"y0": 0,
"y1": 0,
"y2": 157,
"y3": 158
},
"width": 249
},
"Code": "noPermission",
"Message": "You are not authorized to perform this operation."
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史