RecognizeInternationalIdcard - 国际身份证识别

可对国外身份证件进行结构化识别,目前支持越南、韩国、印度、孟加拉居民身份证,可识别字段包括姓名、出生日期、证件号码等。

接口说明

本接口适用场景

  • 阿里云国际身份证识别,是阿里云官方自研 OCR 文字识别产品,适用于出入境审查、国内外身份核验等各种需要提取身份证信息的场景。
  • 阿里云 OCR 产品基于阿里巴巴达摩院强大的 AI 技术及海量数据,历经多年沉淀打磨,具有服务稳定、操作简易、实时性高、能力全面等几大优势。
  • 本接口图片示例

本接口核心能力

分类概述
多国身份证对越南、韩国、印度、孟加拉居民身份证提供识别服务
图像增强默认支持图像增强,包括图像自动旋转、畸变自动矫正、模糊图片自动增强等能力。
多类型覆盖支持模糊、光照不均、透视畸变、任意背景等低质量图像识别。
高精度识别总体识别准确率可达 98%。

如何使用本接口

步骤概述
1开通 个人证照识别 服务。开通服务前后,您可以通过体验馆免费体验本功能识别效果。
2购买国际身份证识别资源包。本 API 会赠送免费额度,可使用免费额度测试。您也可以不购买资源包,系统会通过“按量付费”方式按实际调用量自动扣款。
3可以参照调试页面提供的代码示例完成 API 接入开发。接入完成后,调用 API 获取识别结果。如果使用子账号调用接口,需要阿里云账号(主账号)对 RAM 账号进行授权。创建 RAM 用户的具体操作,请参考:创建 RAM 用户。文字识别服务提供一种系统授权策略,即 AliyunOCRFullAccess。具体授权操作,请参见在用户页面为 RAM 用户授权。

重要提示

类型概述
图片格式
  • 本接口支持:PNG、JPG、JPEG、BMP、GIF、TIFF、WebP、OFD、PDF 格式。
图片尺寸
  • 图片长宽需要大于 15 像素,小于 8192 像素。
  • 长宽比需要小于 50。
  • 如需达到较好识别效果,建议长宽均大于 500px。
图片大小
  • 图片二进制文件不能超过 10MB。
  • 图片过大会影响接口响应速度,建议使用小于 1.5M 图片进行识别,且通过传图片 URL 的方式调用接口。
其他提示
  • 请保证整张身份证内容及其边缘包含在图像内。
  • 本能力会自动处理反光、扭曲等干扰信息,但会影响精度。请尽量选择清晰度高、无反光、无扭曲的图片。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ocr:RecognizeInternationalIdcard
*全部资源
*

请求参数

名称类型必填描述示例值
Urlstring
  • 本字段和 BODY 字段二选一,不可同时透传或同时为空。
    • 图片链接(长度不超 2048 字节,不支持 base64)。
http://example.jpg
bodybyte
  • 本字段和 URL 字段二选一,不可同时透传或同时为空。
    • 图片二进制文件,最大 10MB。
    • 使用 HTTP 方式调用,把图片二进制文件放到 HTTP body 中上传即可。
    • 使用 SDK 的方式调用,把图片放到 SDK 的 body 中即可。
图片二进制文件
Countrystring
  • 国家名称。
    • 如:India,Vietnam,Korea,Bangladesh。
Vietnam

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求唯一 ID

43A29C77-405E-4CC0-BC55-EE694AD00655
Datastring

调用成功时,返回的设备事件记录。

{"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}
Codestring

状态码

200
Messagestring

详细信息

message

返回参数说明


字段类型说明
dataobject结构化信息,正面为 face 字段,反面为 back 字段。
sliceRectlist结构化信息的坐标信息。
prism_keyValueInfolist结构化信息的坐标信息。
ftypeint是否为复印件(1:是,0:否)。
angleint图片的角度,0 表示正向,90 表示图片朝右,180 朝下,270 朝左。
heightint算法矫正图片后的高度。
widthint算法矫正图片后的宽度。
orgHeightint原图的高度。
orgWidthint原图的宽度。

印度身份证正面识别结果(face 字段)

字段类型说明
namestring本国姓名。
nameEnstring英文姓名。
birthDatestring出生日期。
sexstring性别。
cardNumberstring证件号码。
virtualNumberstring虚拟号码。

印度身份证反面识别结果(back 字段)

字段类型说明
addressstring本国地址。
addressEnstring英文地址。
cardNumberstring证件号码。
virtualNumberstring虚拟号码。

印度纳税人识别证识别结果

字段类型说明
birthDatestring生日。
fatherNamestring父亲姓名。
namestring姓名。
taxIdstring税号。

越南身份证正面识别结果(face 字段)

字段类型说明
birthDatestring出生日期。
validToDatestring有效期至。
residencestring居住地。
cardTypestring证件类型。
placeOfAncestrystring原籍地。
cardNumberstring证件号码。
namestring姓名。
sexstring性别。
nationalitystring国籍。

越南身份证反面识别结果(back 字段)

字段类型说明
issuerstring签发人。
mrzLine1string机读码一。
mrzLine2string机读码二。
mrzLine3string机读码三。
personalCharacteristicsstring身份识别特征。
issueDatestring签发日期。

韩国身份证识别结果

字段类型说明
namestring本国姓名。
nameChnstring中文姓名。
cardNumberstring证件号码。
addressstring住址。
issueDatestring签发日期。
issuerstring签发人。

孟加拉国身份证识别结果

字段类型说明
namestring本国姓名。
nameEnstring英文姓名。
fatherNamestring父亲姓名。
motherNamestring母亲姓名。
birthDatestring出生日期。
cardNumberstring身份证号。

结构化坐标信息(prism_keyValueInfo 字段)

字段类型说明
keystring识别出的字段名称。
keyProbint字段名称置信度。
valuestring识别出的字段名称对应的值。
valueProbint字段名称对应值的置信度。
valuePoslist字段在原图中的四个点坐标(左上、右上、右下、左下)。

示例

正常返回示例

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错误码错误信息
400illegalCountryNamethe country name is not supported.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-09-30OpenAPI 错误码发生变更查看变更详情