中国香港身份证识别。
接口说明
如何使用本接口
| 步骤 | 概述 |
|---|---|
| 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 | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Url | string | 否 |
| https://example.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": "{\n \"algo_version\": \"5e7c3de7fb3969700828bd933ee071782bc22088\",\n \"data\": {\n \"birthDate\": \"01-01-19XX\",\n \"firstIssuedDate\": \"(01-79)\",\n \"idNumber\": \"CXXXXXX(E)\",\n \"issuedCode\": \"***AZ\",\n \"issuedDate\": \"XX-09-03\",\n \"nameCn\": \"李XX\",\n \"nameCode\": \"2621 2535 5174\",\n \"nameEn\": \"LEE, Chi Nan\",\n \"sex\": \"女F\"\n },\n \"ftype\": 0,\n \"height\": 158,\n \"orgHeight\": 158,\n \"orgWidth\": 249,\n \"prism_keyValueInfo\": [\n {\n \"key\": \"nameCn\",\n \"keyProb\": 100,\n \"value\": \"李XX\",\n \"valuePos\": [\n {\n \"x\": 11,\n \"y\": 27\n },\n {\n \"x\": 53,\n \"y\": 27\n },\n {\n \"x\": 53,\n \"y\": 40\n },\n {\n \"x\": 11,\n \"y\": 40\n }\n ],\n \"valueProb\": 100\n },\n {\n \"key\": \"nameEn\",\n \"keyProb\": 97,\n \"value\": \"LEE, XX\",\n \"valuePos\": [\n {\n \"x\": 10,\n \"y\": 40\n },\n {\n \"x\": 81,\n \"y\": 40\n },\n {\n \"x\": 81,\n \"y\": 51\n },\n {\n \"x\": 10,\n \"y\": 51\n }\n ],\n \"valueProb\": 97\n },\n {\n \"key\": \"nameCode\",\n \"keyProb\": 100,\n \"value\": \"XXX\",\n \"valuePos\": [\n {\n \"x\": 73,\n \"y\": 54\n },\n {\n \"x\": 155,\n \"y\": 54\n },\n {\n \"x\": 155,\n \"y\": 64\n },\n {\n \"x\": 73,\n \"y\": 64\n }\n ],\n \"valueProb\": 100\n },\n {\n \"key\": \"birthDate\",\n \"keyProb\": 100,\n \"value\": \"01-01-19XX\",\n \"valuePos\": [\n {\n \"x\": 73,\n \"y\": 86\n },\n {\n \"x\": 133,\n \"y\": 85\n },\n {\n \"x\": 133,\n \"y\": 93\n },\n {\n \"x\": 74,\n \"y\": 95\n }\n ],\n \"valueProb\": 100\n },\n {\n \"key\": \"sex\",\n \"keyProb\": 98,\n \"value\": \"女F\",\n \"valuePos\": [\n {\n \"x\": 153,\n \"y\": 84\n },\n {\n \"x\": 171,\n \"y\": 84\n },\n {\n \"x\": 171,\n \"y\": 94\n },\n {\n \"x\": 153,\n \"y\": 94\n }\n ],\n \"valueProb\": 98\n },\n {\n \"key\": \"issuedCode\",\n \"keyProb\": 99,\n \"value\": \"***AZ\",\n \"valuePos\": [\n {\n \"x\": 75,\n \"y\": 97\n },\n {\n \"x\": 104,\n \"y\": 97\n },\n {\n \"x\": 104,\n \"y\": 106\n },\n {\n \"x\": 75,\n \"y\": 106\n }\n ],\n \"valueProb\": 99\n },\n {\n \"key\": \"firstIssuedDate\",\n \"keyProb\": 100,\n \"value\": \"(01-79)\",\n \"valuePos\": [\n {\n \"x\": 74,\n \"y\": 119\n },\n {\n \"x\": 115,\n \"y\": 118\n },\n {\n \"x\": 115,\n \"y\": 126\n },\n {\n \"x\": 75,\n \"y\": 128\n }\n ],\n \"valueProb\": 100\n },\n {\n \"key\": \"issuedDate\",\n \"keyProb\": 100,\n \"value\": \"15-09-03\",\n \"valuePos\": [\n {\n \"x\": 74,\n \"y\": 135\n },\n {\n \"x\": 133,\n \"y\": 133\n },\n {\n \"x\": 133,\n \"y\": 143\n },\n {\n \"x\": 75,\n \"y\": 144\n }\n ],\n \"valueProb\": 100\n },\n {\n \"key\": \"idNumber\",\n \"keyProb\": 100,\n \"value\": \"XXXXXX(E)\",\n \"valuePos\": [\n {\n \"x\": 160,\n \"y\": 134\n },\n {\n \"x\": 232,\n \"y\": 133\n },\n {\n \"x\": 232,\n \"y\": 142\n },\n {\n \"x\": 161,\n \"y\": 144\n }\n ],\n \"valueProb\": 100\n }\n ],\n \"sliceRect\": {\n \"x0\": 0,\n \"x1\": 248,\n \"x2\": 248,\n \"x3\": 0,\n \"y0\": 0,\n \"y1\": 0,\n \"y2\": 157,\n \"y3\": 158\n },\n \"width\": 249\n}",
"Code": "如果识别成功，不会返回此字段",
"Message": "如果识别成功，不会返回此字段\n"
}错误码
访问错误中心查看更多错误码。