国际身份证识别。
接口说明
本接口适用场景
- 阿里云国际身份证识别，是阿里云官方自研 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:RecognizeInternationalIdcard | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Url | string | 否 |
| http://example.jpg |
| body | byte | 否 |
| 图片二进制文件 |
| Country | string | 是 |
| Vietnam |
返回参数
返回参数说明
| 字段 | 类型 | 说明 |
|---|---|---|
| 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 | 原图的宽度。 |
印度身份证正面识别结果（face 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| name | string | 本国姓名。 |
| nameEn | string | 英文姓名。 |
| birthDate | string | 出生日期。 |
| sex | string | 性别。 |
| cardNumber | string | 证件号码。 |
| virtualNumber | string | 虚拟号码。 |
印度身份证反面识别结果（back 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| address | string | 本国地址。 |
| addressEn | string | 英文地址。 |
| cardNumber | string | 证件号码。 |
| virtualNumber | string | 虚拟号码。 |
印度纳税人识别证识别结果
| 字段 | 类型 | 说明 |
|---|---|---|
| birthDate | string | 生日。 |
| fatherName | string | 父亲姓名。 |
| name | string | 姓名。 |
| taxId | string | 税号。 |
越南身份证正面识别结果（face 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| birthDate | string | 出生日期。 |
| validToDate | string | 有效期至。 |
| residence | string | 居住地。 |
| cardType | string | 证件类型。 |
| placeOfAncestry | string | 原籍地。 |
| cardNumber | string | 证件号码。 |
| name | string | 姓名。 |
| sex | string | 性别。 |
| nationality | string | 国籍。 |
越南身份证反面识别结果（back 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| issuer | string | 签发人。 |
| mrzLine1 | string | 机读码一。 |
| mrzLine2 | string | 机读码二。 |
| mrzLine3 | string | 机读码三。 |
| personalCharacteristics | string | 身份识别特征。 |
| issueDate | string | 签发日期。 |
韩国身份证识别结果
| 字段 | 类型 | 说明 |
|---|---|---|
| name | string | 本国姓名。 |
| nameChn | string | 中文姓名。 |
| cardNumber | string | 证件号码。 |
| address | string | 住址。 |
| issueDate | string | 签发日期。 |
| issuer | string | 签发人。 |
孟加拉国身份证识别结果
| 字段 | 类型 | 说明 |
|---|---|---|
| name | string | 本国姓名。 |
| nameEn | string | 英文姓名。 |
| fatherName | string | 父亲姓名。 |
| motherName | string | 母亲姓名。 |
| birthDate | string | 出生日期。 |
| cardNumber | string | 身份证号。 |
结构化坐标信息（prism_keyValueInfo 字段）
| 字段 | 类型 | 说明 |
|---|---|---|
| key | string | 识别出的字段名称。 |
| keyProb | int | 字段名称置信度。 |
| value | string | 识别出的字段名称对应的值。 |
| valueProb | int | 字段名称对应值的置信度。 |
| valuePos | list | 字段在原图中的四个点坐标（左上、右上、右下、左下）。 |
示例
正常返回示例
JSON格式
{
"RequestId": "43A29C77-405E-4CC0-BC55-EE694AD00655",
"Data": "{\"algo_version\":\"a85a881220cbffb0eca30e4026bef242a3eabf47\",\"data\":{\"face\":{\"algo_version\":\"d0e343cb2b8da642748ec51aefda1d6ba50e52e0\",\"data\":{\"name\":\"HR****\",\"nameEn\":\"Bha****\",\"birthDate\":\"19****\",\"sex\":\"****\",\"cardNumber\":\"22803****\",\"virtualNumber\":\"9167738****\"},\"ftype\":0,\"height\":1213,\"orgHeight\":1213,\"orgWidth\":1708,\"prism_keyValueInfo\":[{\"key\":\"name\",\"keyProb\":72,\"value\":\"HR****\",\"valuePos\":[{\"x\":545,\"y\":271},{\"x\":780,\"y\":284},{\"x\":777,\"y\":347},{\"x\":541,\"y\":333}],\"valueProb\":72},{\"key\":\"nameEn\",\"keyProb\":100,\"value\":\"Bha****\",\"valuePos\":[{\"x\":547,\"y\":340},{\"x\":947,\"y\":362},{\"x\":943,\"y\":419},{\"x\":543,\"y\":397}],\"valueProb\":100},{\"key\":\"birthDate\",\"keyProb\":100,\"value\":\"19****\",\"valuePos\":[{\"x\":907,\"y\":423},{\"x\":1197,\"y\":436},{\"x\":1194,\"y\":491},{\"x\":905,\"y\":479}],\"valueProb\":100},{\"key\":\"sex\",\"keyProb\":100,\"value\":\"****\",\"valuePos\":[{\"x\":662,\"y\":472},{\"x\":814,\"y\":479},{\"x\":812,\"y\":529},{\"x\":661,\"y\":523}],\"valueProb\":100},{\"key\":\"cardNumber\",\"keyProb\":100,\"value\":\"22803****\",\"valuePos\":[{\"x\":515,\"y\":973},{\"x\":1283,\"y\":992},{\"x\":1281,\"y\":1074},{\"x\":512,\"y\":1054}],\"valueProb\":100},{\"key\":\"virtualNumber\",\"keyProb\":98,\"value\":\"9167738****\",\"valuePos\":[{\"x\":587,\"y\":1068},{\"x\":1265,\"y\":1086},{\"x\":1264,\"y\":1142},{\"x\":585,\"y\":1123}],\"valueProb\":98}],\"sliceRect\":{\"x0\":0,\"y0\":0,\"x1\":1708,\"y1\":44,\"x2\":1706,\"y2\":1213,\"x3\":0,\"y3\":1213},\"type\":\"印度身份证正面\",\"width\":1708}},\"height\":1213,\"orgHeight\":1213,\"orgWidth\":1708,\"width\":1708}",
"Code": "200",
"Message": "message"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | illegalCountryName | the country name is not supported. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2022-09-30 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|