异步检测_结构化卡证OCR_图片OCR_图片_API参考（检测服务）

本文介绍了调用图片异步检测接口（/green/image/asyncscan）进行结构化卡证OCR识别的方法。结构化卡证OCR能够识别证件类图片中的文字并以结构化的方式返回文字内容。使用该场景的前提是您知道要检测的图片包含哪种类型的证件。

结构化卡证OCR目前支持识别以下卡证类型：营业执照、身份证（正反面）、身份证、护照、银行卡、驾驶证（正反面）、行驶证（正反面）、车牌、车辆VIN码、不动产证、银行开户许可证、户口簿户主页、户口簿常住人口页、食品经营许可证、食品生产许可证、商标注册证、结婚证、毕业证书、专利证书、（中国内地）著作权作品登记证书、（中国内地）著作权软件著作权登记书。

图片异步检测接口说明

业务接口：/green/image/asyncscan，表示图片异步检测。

您可以调用该接口创建图片异步检测任务。关于如何构造HTTP请求，请参见请求结构；您也可以直接选用已构造好的HTTP请求，具体请参见SDK概览。

计费信息：
该接口为收费接口，具体计费方式请参见内容安全产品定价。
检测超时：
同步检测允许的最长检测时间是6秒，如果检测在该时间限制内没有完成，系统会强制返回超时错误码。如果您对实时性要求不高，可以选择异步检测，其他情况下请选择同步检测，同步检测接口的调用相对简单些。对于同步检测接口的调用，建议您将超时时间设置为6秒。
返回结果：
异步检测任务不会实时返回检测结果，您需要通过callback或者轮询的方式获取检测结果。检测结果最长保留一小时。
- callback获取检测结果：提交异步检测任务时，在请求参数中传入callback参数，用来自动接收检测结果，具体请参见（异步检测）请求参数。
- 轮询获取检测结果：提交异步检测任务时，无需传入callback参数；提交异步检测任务后，调用结果查询接口获取检测结果，具体请参见图片异步检测结果查询接口说明。
图片要求：
- 图片链接支持以下协议：HTTP和HTTPS。
- 图片支持以下格式：PNG、JPG、JPEG、BMP、GIF、WEBP。
- 图片大小限制为10 MB以内（适用于同步和异步调用）。如您有特殊需求（大图片），可以提交工单进行调整。
- 图片下载时间限制为3秒内，如果下载时间超过3秒，返回下载超时。
- 图片像素建议不低于256*256，像素过低可能会影响识别效果。
- 图片检测接口响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠，建议您使用阿里云OSS存储或者CDN缓存等。

（异步检测）请求参数


名称	类型	是否必须	描述
bizType	字符串	否	该字段用于标识您的业务场景。您可以通过内容安全控制台创建业务场景（具体操作请参见自定义机审标准），或者提交工单联系我们帮助您创建业务场景。
scenes	字符串数组	是	指定检测场景，取值：ocr。
callback	字符串	否	异步检测结果回调通知您的URL，支持使用HTTP和HTTPS协议的地址。该字段为空时，您必须定时轮询检测结果。 callback接口必须支持POST方法、UTF-8编码的传输数据，以及表单参数checksum和content。内容安全按照以下规则和格式设置checksum和content，调用您的callback接口返回检测结果。 checksum：字符串格式，由`用户uid + seed + content`拼成字符串，通过SHA256算法生成。用户UID即阿里云账号ID，可以在阿里云控制台查询。为防篡改，您可以在获取到推送结果时，按上述算法生成字符串，与checksum做一次校验。说明用户UID必须是阿里云主账号UID，而非子账号UID。 content：JSON字符串格式，请自行解析反转成JSON对象。content结果的示例请参见查询异步检测结果的返回示例。说明您的服务端callback接口收到内容安全推送的结果后，如果返回的HTTP状态码为200，则表示接收成功，其他的HTTP状态码均视为接收失败。接收失败时，内容安全将最多重复推送16次检测结果，直到接收成功。重复推送16次后仍未接收成功，则不再推送，建议您检查callback接口的状态。
seed	字符串	否	随机字符串，该值用于回调通知请求中的签名。当使用callback时，该字段必须提供。
tasks	JSON数组	是	指定检测对象，JSON数组中的每个元素是一个OCR图文检测任务结构体。最多支持10个元素，即对10张图片进行识别。每个元素的具体结构描述请参见task。
extras	JSON结构体	是	指定要识别的证件类型，格式为`{"card":"${CardType}"}`。`CardType`表示证件类型，取值： business-license：营业执照 id-card-front：身份证正面 id-card-back：身份证反面 passport：护照 bank-card：银行卡 driver-license-front：驾驶证正面 driver-license-back：驾驶证反面 vehicle-license-front：行驶证正面 vehicle-license-back：行驶证反面 vehicle-num：车牌 vehicle-vin：车辆VIN码 estate-cert：不动产证 bank-account-permit：银行开户许可证 household-head：户口簿户主页 household-resident：户口簿常住人口页 food-blicense：食品经营许可证 food-plicense：食品生产许可证 trade-mark-certificate：商标注册证 marriage：结婚证 graduation：毕业证书 patent-cert：专利证书 work-reg-cert：（中国内地）著作权作品登记证书 software-reg：（中国内地）著作权软件著作权登记书

表 1. task
名称	类型	是否必须	描述
dataId	字符串	否	数据ID。需要保证在一次请求中所有的ID不重复。
url	字符串	是	待检测图片的URL。

（异步检测）返回数据


名称	类型	描述
code	整型	错误码，和HTTP状态码一致。
msg	字符串	错误描述信息。
dataId	字符串	检测对象对应的数据ID。说明如果在检测请求参数中传入了dataId，则此处返回对应的dataId。
taskId	字符串	检测任务的ID。
url	字符串	检测对象的URL。
extras	JSON结构体	额外调用参数，对应检测请求参数中的extras。说明该参数可能会被调整，目前请勿依赖该参数的返回值。

（异步检测）示例

请求示例

说明以银行卡识别为例（extras传入{"card": "bank-card"}）。如果需要识别其他类型的卡证，传入对应的卡证类型即可，具体请参见（异步检测）请求参数。

{
    "scenes": [
        "ocr"
    ],
    "extras": {
        "card": "bank-card"
    },
    "tasks": [
        {
            "dataId": "test_data_xxxx",
            "url": "https://test_image_xxxx.png"
        }
    ]
}

正常返回示例

{
    "code": 200,
    "msg": "OK",
    "requestId": "92AD868A-F5D2-4AEA-96D4-E1273B8E074C",
    "data": [
        {
            "code": 200,
            "msg": "OK",
            "dataId": "test_data_xxxx",
            "taskId": "img5A@k7a@B4q@6K@d9nfKgOs-1sWeLu",
            "url": "https://test_image_xxxx.png"
        }
    ]
}

图片异步检测结果查询接口说明

业务接口：/green/image/results，表示查询图片异步检测结果。

您可以调用该接口查询图片异步检测任务的结果。关于如何构造HTTP请求，请参见请求结构；您也可以直接选用已构造好的HTTP请求，具体请参见SDK概览。

计费信息：
该接口不计费。
查询超时：
建议您将查询间隔设置为30秒（即在提交异步检测任务30秒后查询结果），最长不能超出4个小时，否则结果将会丢失。

（结果查询）请求参数


名称	类型	是否必须	描述
body	JSON数组	是	要查询的异步检测任务的taskId列表。数组长度不超过1000。

（结果查询）返回数据


名称	类型	描述
code	整型	错误码，和HTTP的status code一致。
msg	字符串	错误描述信息。
dataId	字符串	检测对象对应的数据ID。说明如果在检测请求参数中传入了dataId，则此处返回对应的dataId。
taskId	字符串	检测任务的ID。
url	字符串	检测对象的URL。
extras	JSON结构体	额外调用参数，对应检测请求参数中的extras。说明该参数可能会被调整，目前请勿依赖该参数的返回值。
results	数组	返回结果。调用成功时（code=200），返回结果中包含一个或多个元素。每个元素是个结构体，具体结构描述请参见result。

表 2. result
名称	类型	描述
scene	字符串	检测场景，取值：ocr。
label	字符串	检测结果的分类。取值： normal：图片中未识别出文字信息。 ocr：图片中包含文字信息。
suggestion	字符串	建议用户执行的操作，取值： pass：无需关注返回结果。 review：关注识别出的文字信息。
rate	浮点数	在OCR图文识别场景中，可以不用关注该返回值。
businessLicenseInfo	结构体	识别出来的营业执照信息，具体结构描述请参见businessLicenseInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"business-license"}`才会返回该结果。
idCardInfo	结构体	识别出来的身份证信息，具体结构描述请参见idCardInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"id-card-front"}`或`{"card":"id-card-back"}`才会返回该结果。
passportInfo	结构体	识别出来的护照信息，具体结构描述请参见passportInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"passport"}`才会返回该结果。
bankCardInfo	结构体	识别出来的银行卡信息，具体结构描述请参见bankCardInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"bank-card"}`才会返回该结果。
driverLicenseFrontInfo	结构体	识别出来的驾驶证正面信息，具体结构描述请参见driverLicenseFrontInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"driver-license-front"}`才会返回该结果。
driverLicenseBackInfo	结构体	识别出来的驾驶证反面信息，具体结构描述请参见driverLicenseBackInfo。说明只有在异步检测任务的请求参数extras中指定`{"card":"driver-license-back"}`才会返回该结果。
vehicleLicenseFrontInfo	结构体	识别出来的行驶证正面信息，具体结构描述请参见vehicleLicenseFrontInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"vehicle-license-front"}`才会返回该结果。
vehicleLicenseBackInfo	结构体	识别出来的行驶证反面信息，具体结构描述请参见vehicleLicenseBackInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"vehicle-license-back"}`才会返回该结果。
vehicleNumInfo	结构体	识别出来的车牌信息，具体结构描述请参见vehicleNumInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"vehicle-num"}`才会返回该结果。
vehicleVinInfo	结构体	识别出来的车辆VIN码信息，具体结构描述请参见vehicleVinInfo。说明只有在异步检测任务的请求参数extras中指定了`{"card":"vehicle-vin"}`才会返回该结果。
ocrCardInfo	结构体	识别出来的其他卡证的OCR信息，具体结构请参见ocrCardInfo。说明只有在异步检测任务的请求参数extras中指定了以下内容，才会返回相应结果： `{"card":"estate-cert"}`：返回不动产证信息。 `{"card":"bank-account-permit"}`：返回银行开户许可证信息。 `{"card":"household-head"}`：返回户口簿户主页信息。 `{"card":"household-resident"}`：返回户口簿常住人口页信息。 `{"card":"food-blicense"}`：返回食品经营许可证信息。 `{"card":"food-plicense"}`：返回食品生产许可证信息。 `{"card":"trade-mark-certificate"}`：返回商标注册证信息。 `{"card":"marriage"}`：返回结婚证信息。 `{"card":"graduation"}`：返回毕业证书信息。 `{"card":"patent-cert"}`：返回专利证书信息。 `{"card":"work-reg-cert"}`：返回（中国内地）著作权作品登记证书信息。 `{"card":"software-reg"}`：返回（中国内地）著作权软件著作权登记书信息。

表 3. businessLicenseInfo
名称	类型	描述
companyName	字符串	公司名称。
companyType	字符串	公司类型。
legalPerson	字符串	企业法人。
establishDate	字符串	注册日期。
vaildPeriod	字符串	营业终止日期。
address	字符串	地址。
capital	字符串	注册资本。
business	字符串	经营范围。
copy	布尔型	是否是副本。取值： true：是 false：否
copyId	字符串	副本号。
certSN	字符串	证照编号。
creditCode	字符串	统一社会信用代码。
organizationCode	字符串	组织机构代码。
taxCode	字符串	税务登记号。
companySN	字符串	公司编号。
composition	字符串	组成形式。
paidInCapital	字符串	实收资本。

表 4. idCardInfo
名称	类型	描述
name	字符串	姓名。
sex	字符串	性别。取值：男女
nationality	字符串	民族。
number	字符串	身份证号。
birth	字符串	出生日期。格式：yyyy-MM-dd。
address	字符串	住址。
authority	字符串	签发机构。
startDate	字符串	有效期开始日期。格式：yyyy-MM-dd。
endDate	字符串	有效期结束日期。格式：yyyy-MM-dd。说明该字段可能返回以下值：长期。
angle	浮点数	证件顺时针旋转的角度。
copy	布尔型	身份证照片是否是复印件。取值： true：是 false：否说明默认不返回该字段。如果需要返回，请提交工单联系我们。
remake	布尔型	身份证照片是否是翻拍。取值： true：是 false：否说明默认不返回该字段。如果需要返回，请提交工单联系我们。
type	字符串	证件类型。取值： front：身份证正面（人像面） back：身份证背面（国徽面） front_back：正常身份证正反同页 interim_front：临时身份证正面（人像面） interim_back：临时身份证背面（国徽面） interim_front_back：临时身份证正反同页
numberValid	布尔型	证件号码是否合法。取值： true：是 false：否说明如果长度不正确或者号码不符合国家规范，会返回false。

表 5. passportInfo
名称	类型	描述
authority	字符串	发证机关。
birthDate	字符串	出生日期。
birthDay	字符串	生日。
birthPlace	字符串	出生地。
birthPlaceRaw	字符串	出生地（字母）。
expireDate	字符串	到期时间。
expireDay	字符串	到期日。
issueDate	字符串	发证日期。
issuePlace	字符串	发证地址。
issuePlaceRaw	字符串	发证地址（字母）。
name	字符串	姓名。
cnName	字符串	中文名称。
cnNameRaw	字符串	中文名称（字母）。
personId	字符串	身份ID。
sex	字符串	性别。
srcCountry	字符串	国籍。
type	字符串	类型。
line0	字符串	底部第一行。
line1	字符串	底部第二行。

表 6. bankCardInfo
名称	类型	描述
bankCardNum	字符串	银行卡号。

表 7. driverLicenseFrontInfo
名称	类型	描述
name	字符串	姓名。
number	字符串	驾驶证号。
sex	字符串	性别。取值：男女
address	字符串	住址。
vehicleType	字符串	准驾车型。
validStartDate	字符串	有效期开始时间，格式：yyyy-MM-dd。
validEndDate	字符串	有效期截止时间，格式：yyyy-MM-dd。

表 8. driverLicenseBackInfo
名称	类型	描述
archiveNum	字符串	档案编号。

表 9. vehicleLicenseFrontInfo
名称	类型	描述
plateNum	字符串	车牌号。
vehicleType	字符串	车辆类型。
owner	字符串	所有者名字。
useCharacter	字符串	车辆使用性质。
address	字符串	住址。
model	字符串	车辆品牌。
vin	字符串	车辆识别代号。
engineNum	字符串	发动机号码。
registerDate	字符串	注册日期，格式：yyyy-MM-dd。
issueDate	字符串	发证日期，格式：yyyy-MM-dd。

表 10. vehicleLicenseBackInfo
名称	类型	描述
plateNum	字符串	车牌号。
fileNum	字符串	档案编号。
appprovedPassengerCapacity	整型	核定载人数。
grossMass	字符串	总质量。
unladenMass	字符串	整备质量。
approvedLoad	字符串	核定载质量。
tractionMass	字符串	准牵引总质量。
inspectionRecord	字符串	检验记录。
overallDimension	结构体	车辆轮廓尺寸信息，具体结构描述请参见overallDimension。

表 11. overallDimension
名称	类型	描述
length	整型	车辆长度，单位：毫米。
width	整型	车辆宽度，单位：毫米。
height	整型	车辆高度，单位：毫米。

表 12. VehicleNumInfo
名称	类型	描述
num	字符串	车牌号。
rate	浮点数	车牌号的置信度，取值范围：0~100。值越高表示识别出的车牌号越可信。
vehicleType	字符串	车牌类型，取值：小型汽车新能源车大型汽车挂车教练车警车军车使领馆车港澳车
vehicleTypeRate	浮点数	车牌类型的置信度，取值范围：0~100。值越高表示识别出的车牌类型越可信。

表 13. VehicleVinInfo
名称	类型	描述
vin	字符串	VIN号。

ocrCardInfo

不动产证信息


名称	类型	描述
usage	字符串	用途。
rightType	字符串	权利类型。
location	字符串	坐落。
otherInfo	字符串	权利其他状况。
rightNumber	字符串	证号。
buildingUnitNumber	字符串	不动产单元号。
rightProperty	字符串	权利性质。
rightHolder	字符串	权利人。
sharedInfo	字符串	共有情况。
termLimit	字符串	使用期限。
landNumber	字符串	丘权号。
area	字符串	面积。
constructionArea	字符串	房屋建筑面积。
type	字符串	卡证的类型，取值固定为estate-cert，表示不动产证。

银行开户许可证信息


名称	类型	描述
account	字符串	账号。
legalPerson	字符串	法定代表人。
approvalNumber	字符串	核准号。
name	字符串	名称。
title	字符串	标题。
serialNumber	字符串	编号。
bankName	字符串	开户银行。
type	字符串	卡证的类型，取值固定为bank-account-permit，表示银行开户许可证。

户口簿户主页信息


名称	类型	描述
locationNumber	字符串	地段号。
issueDate	字符串	签发日期。
householdType	字符串	户别。
houseHolder	字符串	户主姓名。
address	字符串	住址。
community	字符串	户主社区。
householdNumber	字符串	户号。
undertaker	字符串	承办人签章。
type	字符串	卡证的类型，取值固定为household-head，表示户口簿户主页。

户口簿常住人口页信息


名称	类型	描述
occupation	字符串	职业。
migrationDate1	字符串	何时由何地迁来本址。
idNumber	字符串	身份证编号。
education	字符串	文化程度。
birthPlace	字符串	出生地。
servicePremises	字符串	服务处所。
householdNumber	字符串	户号。
hometown	字符串	籍贯。
gender	字符串	性别。
name	字符串	姓名。
formerName	字符串	曾用名。
maritalStatus	字符串	婚姻状况。
ation	字符串	民族。
otherAddress	字符串	本市其他住址。
birthday	字符串	出生日期。
militaryService	字符串	兵役状况。
relationTo	字符串	与户主关系。
religion	字符串	宗教信仰。
bloodType	字符串	血型。
registerDate	字符串	登记日期。
height	字符串	身高。
migrationDate2	字符串	何时何地迁来本市。
undertaker	字符串	承办人签章。
type	字符串	卡证的类型，取值固定为household-resident，表示户口簿常住人口页。

食品经营许可证信息


名称	类型	描述
licenseNo	字符串	许可证编号。
manager	字符串	经营者名称。
premise	字符串	经营场所。
superviseOrg	字符串	日常监督管理结构。
supervisor	字符串	日常监督管理人员。
project	字符串	经营项目。
expireDate	字符串	有效期截止日期。
id	字符串	社会信用代码（身份证号码）。
residence	字符串	住所。
authorizeOrg	字符串	发证机关。
legalPerson	字符串	法定代表人（负责人）。
businessScope	字符串	主体业态。
authorizer	字符串	签发人。

食品生产许可证信息


名称	类型	描述
legalPerson	字符串	法定代表人（负责人）。
superviseOrg	字符串	日常监督管理机构。
supervisor	字符串	日常监督管理人员。
expireDate	字符串	有效期截止日期。
licenseNo	字符串	许可证编号。
id	字符串	社会信用代码（身份证号码）。
address	字符串	生产地址。
residence	字符串	住所。
category	字符串	食品类别。
issueDate	字符串	发证日期。
authorizeOrg	字符串	发证机关。
authorizer	字符串	签发人。
producer	字符串	生产者名称。

商标注册证信息


名称	类型	描述
specification	字符串	核定使用商品或服务项目。
trademark	字符串	商标名称。
authorizer	字符串	局长。
code	字符串	编码。
ownerAddr	字符串	注册人地址。
owner	字符串	注册人。
serialNo	字符串	知识产权编号。
expireDate	字符串	有效期截止日期。
serviceType	字符串	核定服务项目。
registerDate	字符串	注册日期。
validPeriod	字符串	注册有效期限。

结婚证信息


名称	类型	描述
name1	字符串	持证人甲姓名。
name2	字符串	持证人乙姓名。
id1	字符串	持证人甲身份证号。
id2	字符串	持证人乙身份证号。
birthDate1	字符串	持证人甲出生日期。
birthDate2	字符串	持证人乙出生日期。
nationality1	字符串	持证人甲国籍。
Nationality2	字符串	持证人乙国籍。
gender1	字符串	持证人甲性别。
gender2	字符串	持证人乙性别。
fontSize	字符串	字号。
issueDate	字符串	发证日期。
registerDate	字符串	登记日期。
holder	字符串	持证人。

毕业证书信息


名称	类型	描述
student	字符串	学生。
collage	字符串	大学或学院名称。
certificateNo	字符串	证书编号。
major	字符串	专业。
gender	字符串	性别。

专利证书信息


名称	类型	描述
patentee	字符串	专利权人。
designName	字符串	外观设计名称。
title	字符串	标题。
applyDate	字符串	专利申请日。
patentNo	字符串	专利号。

（中国内地）著作权作品登记证书信息


名称	类型	描述
rightOwner	字符串	专利权人。
propertyType	字符串	作品类别。
propertyName	字符串	作品或制品名称。
registerDate	字符串	登记日期。
registerNo	字符串	登记号。

（中国内地）著作权软件著作登记书信息


名称	类型	描述
rightOwner	字符串	著作权人。
firstPubName	字符串	首次发表日期。
softwareName	字符串	软件名称。
registerNo	字符串	登记号。

（结果查询）示例