华为云用户手册

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，银行卡识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/bankcard”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入银行卡图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/bankcard Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入银行卡图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/bankcard Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

响应示例 状态码：200 成功响应示例 { "result": { "bank_name": "XX银行", "card_number": "XXXX XXXX XXXX XXXX", "issue_date": "12/10", "expiry_date": "12/20", "type": "", "confidence": { "bank_name": 0.9431, "card_number": 0.8562, "issue_date": 0.9962, "expiry_date": 0.9256, "type": 0 } } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result BankcardResult object 识别结果。 调用失败时不返回此字段。 表5 BankcardResult 参数 参数类型 描述 bank_name String 发卡行。 card_number String 银行卡号。 issue_date String 有效期开始日期。 expiry_date String 有效期截止日期。 type String 银行卡类别，如：借记卡，信用卡，准贷记卡，预付费卡。 如果参数返回为空，表示未识别到银行卡类别。 confidence Object 字段的置信度，取值范围0~1。 置信度越大，表示识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 text_location Object 对应所有在原图上识别到的字段位置信息，包含所有文字区域四个顶点的二维坐标（x,y）。采用图像坐标系，坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 状态码： 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8192px，支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域 如果无该参数，系统默认不返回文字块区域。如果输入参数不是Boolean类型，则会报非法参数错误。

URI POST /v2/{project_id}/ocr/bankcard 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，智能文档解析部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/smart-document-recognizer”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，响应消息头中X-Subject-Token的值即为Token。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 描述 data 否 String 与url二选一。图片或PDF格式，base64编码，要求base64编码后大小不超过10M。 图像尺寸不小于15×15像素，最长边不超过8192像素，支持JPG/PNG/BMP/TIFF格式。 PDF以144dpi的分辨率转为图像进行文档解析，需符合上述图像尺寸规定。若PDF有多页，当前仅对第1页进行识别。 url 否 String 与data二选一。 图片或PDF的URL路径，目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 kv 否 Boolean 是否进行键值对（key-value）提取。若是，结果会以“kv_result”这一关键字返回。 table 否 Boolean 是否进行表格识别。此处表格特指逻辑表格，通常具有M行N列的形式，且第一行或第一列为表头。若是，结果会以“table_result”这一关键字返回。 layout 否 Boolean 是否进行版面分析。若是，结果会以“layout_result”这一关键字返回。 return_excel 否 Boolean 仅当table为True时有效。是否返回表格转换Microsoft Excel的Base64编码字段。 form 否 Boolean 是否进行有线表单识别。有线表单指关键信息以有线单元格形式进行呈现，例如户口本、机动车发票等。若是，结果会以"form_result"这一关键字返回。 kv_map 否 String 需要传入字典的json序列化后字符串，用于对kv_result中的特定key值进行归一化映射。例如，kv_result中包含{"名称"："小明"}的键值对，若传入{"名称"："姓名"}的kv_map，则返回结果为{“姓名”：“小明”}。 说明： 参数传入示例： "kv_map":"{"名称":"姓名"}"

响应示例 状态码： 200 成功响应样例 { "result" : [ { "layout_result" : { "layout_block_count" : 19, "layout_block_list" : [ { "location" : [ [ 1165, 368 ], [ 2031, 368 ], [ 2031, 465 ], [ 1165, 465 ] ], "type" : "title", "text" : "黑龙江增值税专用发票", "words_ids" : [ 0 ] }, { "location" : [ [ 15, 19 ], [ 1078, 19 ], [ 1078, 637 ], [ 15, 637 ] ], "type" : "form", "text" : "xxxx", "words_ids" : [ 2, 3, 4 ], "form_id" : 0 }, { "location" : [ [ 18, 180 ], [ 1077, 180 ], [ 1077, 636 ], [ 18, 636 ] ], "type" : "table", "text" : "xxxx", "words_ids" : [ 0, 1, 2 ], "table_id" : 0 } ] } }, { "form_result" : { "form_count" : 1, "form_list" : [ { "location" : [ [ 15, 19 ], [ 1074, 19 ], [ 1074, 636 ], [ 15, 636 ] ], "words_block_count" : 24, "words_block_list" : [ { "words" : "xxx", "rows" : [ 0 ], "columns" : [ 0, 1, 2 ] }, { "words" : "xxxx", "rows" : [ 1 ], "columns" : [ 0, 1, 2 ] } ], "excel" : "UEsDBBQAAAAIAAAAIQBhXUk6TwEAAI8EAAATAAAAW0NvbnRlbnRfVHlwZX..." } ] } }, { "table_result" : { "table_count" : 1, "table_list" : [ { "words_block_count" : 24, "words_block_list" : [ { "words" : "货物或应税劳务、服务名称", "rows" : [ 0 ], "columns" : [ 0 ] }, { "words" : "规格型号", "rows" : [ 0 ], "columns" : [ 1 ] } ], "excel" : "xxxx", "location" : [ [ 275, 967 ], [ 2919, 967 ], [ 2919, 1177 ], [ 275, 1177 ] ] } ] } }, { "kv_result" : { "kv_block_count" : 25, "kv_block_list" : [ { "key" : "开票日期", "value" : "2017年08月31日", "words_block_count" : 2, "words_block_list" : [ { "words" : "开票日期", "location" : [ [ 2241, 589 ], [ 2480, 592 ], [ 2480, 646 ], [ 2241, 643 ] ], "type" : "key" }, { "words" : "2017年08月31日", "location" : [ [ 2479, 591 ], [ 2850, 595 ], [ 2850, 649 ], [ 2479, 645 ] ], "type" : "value" } ] } ] } }, { "ocr_result" : { "direction" : 0.4767, "words_block_count" : 67, "words_block_list" : [ { "words" : "黑龙江增值税专用发票", "location" : [ [ 430, 100 ], [ 874, 99 ], [ 874, 139 ], [ 430, 141 ] ], "confidence" : 0.9552 } ] } } ] } 状态码： 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }

约束与限制 支持中英文及部分中文繁体字。 只支持识别PNG、JPG、JPEG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD格式的图片以及PDF文档，PDF只支持首页识别。 图像各边的像素大小在15px到8192px之间。 图像中识别区域有效占比超过80%，保证所有文字及其边缘包含在图像内。 支持图像任意角度的水平旋转。 单页字符数不大于1800，以获得较优的识别效果。 目前不支持复杂背景（如户外自然场景、防伪水印等）和文字扭曲图像的文档解析。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

响应示例 状态码： 200 成功响应样例 { "result" : { "type" : "health_code", "name" : "**余", "idcard_number" : "", "phone_number" : "", "province" : "安徽省", "city" : "合肥市", "time" : "2022-03-30 15:37:13", "color" : "green", "vaccination_status" : "x 2已接种新冠疫苗", "pcr_test_result" : "", "pcr_test_organization" : "", "pcr_test_time" : "", "pcr_sampling_time" : "", "reached_city" : "", "confidence" : { "type" : 0.615, "name" : 0.9003, "idcard_number" : 0, "phone_number" : 0, "province" : 0, "city" : 0.8785, "time" : 0.9174, "color" : 0.615, "vaccination_status" : 0.8691, "pcr_test_result" : 0, "pcr_test_organization" : 0, "pcr_test_time" : 0, "pcr_sampling_time" : 0, "reached_city" : 0 }, "words_block_count" : 16, "words_block_list" : [ { "words" : "文字块1", "confidence" : 0.8327, "location" : [ [ 754, 21 ], [ 855, 21 ], [ 855, 60 ], [ 754, 60 ] ] }, { "words" : "文字块2", "confidence" : 0.7972, "location" : [ [ 929, 22 ], [ 1022, 22 ], [ 1022, 59 ], [ 929, 59 ] ] } ] } } 状态码： 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }

请求示例 ndpoint即调用API的请求地址，不同服务不同区域的Endpoint不同，具体请参见终端节点。 例如，防疫健康码识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/health-code”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入防疫健康码图片的base64编码进行文字识别 POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/health-code Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." }

URI POST /v2/{project_id}/ocr/health-code 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 描述 image 否 String 与url二选一。 图片的Base64编码，图片尺寸不小于15×15像素，最长边不超过8192像素，支持JPG/JPEG/PNG/BMP/TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 与image二选一。 图片的URL路径，目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 detect_direction 否 Boolean 校正图片的倾斜角度开关，可选值如下所示： true：校正图片的倾斜角度 false：不校正图片的倾斜角度 支持任意角度的校正，未传入该参数时默认为“false”。 待识别图片如果存在倾斜，建议将此参数设置为“true”。

功能介绍 支持对全国各地区不同版式的防疫健康码中的姓名、健康码更新时间、健康码颜色，并将识别的结构化结果返回给用户。 支持识别4种健康码颜色，包括绿码、黄码、红码、灰码；支持返回各个关键字段的置信度，以便提高人工校验效率。 已推出三码合一功能（健康码、核酸检测记录、行程卡）。您只需要调用1个接口，即可智能结构化识别健康码、核酸检测记录、行程卡等页面信息，包括防疫码类别、姓名、身份证号码、手机号码、省份、城市、健康码或行程卡的更新时间、健康码或行程卡颜色、疫苗接种情况、核酸检测结果、核酸检测机构、核酸检测结果更新时间、核酸检测采样时间、行程卡的途经地址等14个关键字段。 图1 防疫健康码版式示例图

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，增值税发票识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/vat-invoice”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入增值税发票的base64编码进行文字识别，并通过设置“advanced_mode”返回发票类型、联次、金额等信息。 POST https://{endpoint}/v2/{project_id}/ocr/vat-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAj...", "advanced_mode": true } 传入增值税发票的url进行文字识别，并通过设置“advanced_mode”返回发票类型、联次、金额等信息。 POST https://{endpoint}/v2/{project_id}/ocr/vat-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "advanced_mode": true }

响应参数 根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result VatInvoiceResult object 识别结果。 调用失败时不返回此字段。 表5 VatInvoiceResult 参数 参数类型 描述 title String 增值税发票标题。 type String 增值税发票类型，可选值如下所示。 special：增值税专用发票 normal：增值税普通发票 electronic：增值税电子普通发票（含区块链发票） special_electronic：增值税电子专用发票 toll：增值税电子普通发票（通行费） roll：增值税普通发票（卷票） fully_digitalized_special_electronic：全电专用发票 fully_digitalized_normal_electronic：全电普通发票 invoice_tag String 增值税发票左上角标志。当“advanced_mode”设置为“true”时才返回。包含：通行费、代开。 sum_amount String 小计金额，当传入多页PDF时返回此字段。 sum_tax String 小计税额，当传入多页PDF时返回此字段。 serial_number String 发票联次。 当“advanced_mode”设置为“true”时才返回。 attribution String 发票归属地。 当“advanced_mode”设置为“true”时才返回。 supervision_seal Array of strings 发票监制章。 当“advanced_mode”设置为“true”时才返回。 code String 发票代码。 print_code String 机打代码。当“advanced_mode”设置为“true”时才返回。 machine_number String 机器编号。 当“advanced_mode”设置为“true”时才返回。 print_number String 卷票是机打号码，普通发票和专用发票在右上角，电子发票、通行费发票无此字段。 当“advanced_mode”设置为“true”时才返回。 check_code String 发票校验码，特定类型增值税发票内不存在该信息时返回空字符串。 number String 发票号码。 issue_date String 开票日期。 encryption_block String 密码区。 buyer_name String 购买方名称。 buyer_id String 购买方纳税人识别号。 buyer_address String 购买方地址、电话。 buyer_bank String 购买方开户行及账号。 seller_name String 销售方名称。 seller_id String 销售方纳税人识别号。 seller_address String 销售方地址、电话。 seller_bank String 销售方开户行及账号。 subtotal_amount String 合计金额。 subtotal_tax String 合计税额。 total String 价税合计。 total_in_words String 价税合计（大写）。 当“advanced_mode”设置为“true”时才返回。 remarks String 备注。 当“advanced_mode”设置为“true”时才返回。 receiver String 收款人。 当“advanced_mode”设置为“true”时才返回。 reviewer String 复核。 当“advanced_mode”设置为“true”时才返回。 issuer String 开票人。 当“advanced_mode”设置为“true”时才返回。 seller_seal Array of strings 销售方发票专用章。 当“advanced_mode”设置为“true”时才返回。 item_list Array of ItemList objects 货物或应税劳务列表。 province String 省。 city String 市。 confidence Object 各个字段的置信度。 当“advanced_mode”设置为“true”时才返回。 text_location Object 文本框在原图位置。输出左上、右上、右下、左下四个点坐标。 当“return_text_location”设置为“true”时才返回。 belong_buyer_name String 销货清单的购买方名称。 当传入图片为发票销货清单时返回此字段。 belong_seller_name String 销货清单的销售方名称。 当传入图片为发票销货清单时返回此字段。 belong_vat_code String 所属的增值税发票代码。 当传入图片为发票销货清单时返回此字段。 belong_number String 销货清单的开票号码。 当传入图片为发票销货清单时返回此字段。 belong_pages String 销货清单的总页码数。 当传入图片为发票销货清单时返回此字段。 belong_current_page String 销货清单的当前页码。 当传入图片为发票销货清单时返回此字段。 belong_remarks String 销货清单的备注。 当传入图片为发票销货清单时返回此字段。 belong_issue_date String 销货清单的填开日期。 当传入图片为发票销货清单时返回此字段。 sales_mark Boolean 是否是销货清单，可选值为： true：输入图片是销货清单。 false：输入图片不是销货清单。 belong_sum_amount String 销货清单的小计金额。 当传入图片为发票销货清单时返回此字段。 belong_sum_tax String 销货清单的小计税额。 当传入图片为发票销货清单时返回此字段。 belong_subtotal_amount String 销货清单的总计或者合计金额。 当传入图片为发票销货清单时返回此字段。 belong_subtotal_tax String 销货清单的总计税额。 当传入图片为发票销货清单时返回此字段。 belong_discount_amount String 销货清单的折扣金额。 当传入图片为发票销货清单时返回此字段。 belong_discount_tax String 销货清单的折扣税额。 当传入图片为发票销货清单时返回此字段。 belong_item_list Array of BelongItemList objects 销货清单的货物（劳务）名称列表。 当传入图片为发票销货清单时返回此字段。 表6 ItemList 参数 参数类型 描述 name String 货物或应税劳务、服务名称。 specification String 规格型号。 unit String 单位。 quantity String 数量。 unit_price String 单价。 license_plate_number String 车牌号码。 当“type”被识别为“toll”且“advanced_mode”设置为“true”时才返回。 amount String 金额。 tax_rate String 税率。 tax String 税额。 end_date String 通行日期止。 当“type”被识别为“toll”且“advanced_mode”设置为“true”时才返回。 start_date String 通行日期起。 当“type”被识别为“toll”且“advanced_mode”设置为“true”时才返回。 vehicle_type String 车辆类型。 当“type”被识别为“toll”且“advanced_mode”设置为“true”时才返回。 表7 BelongItemList 参数 参数类型 描述 name String 货物或应税劳务、服务名称。 item_number String 序号。 specification String 规格型号。 unit String 单位。 quantity String 数量。 unit_price String 单价。 amount String 金额。 tax_rate String 税率。 tax String 税额。 状态码： 400 表8 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于100px，最长边不超过8192px，支持JPEG、JPG、PNG、BMP、TIFF、PDF、OFD格式，多页PDF仅识别第一页。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 advanced_mode 否 Boolean 默认为false，如果传参为true，则返回更多字段，具体请参见表5。 return_text_location 否 Boolean 默认为false，如果传参为true，则返回text_location字段表示文本框在原图位置。 page_num 否 Integer 页码，默认为1，返回第一页结果。如果传参不大于PDF页数，则返回对应PDF页的结果。

功能介绍 识别增值税发票的类别，并以JSON格式返回识别的结构化结果，支持识别图片、PDF、OFD文件。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。 发票验真API请参见发票验真。 图1 增值税发票示例图 图2 区块链发票示例图 图3 全电发票示例图 对于区块链发票与增值税电子普票的区别参考如下： 一般电子普通发票除了地名，均标明“增值税电子普通发票”，区块链发票除了地名外只标明“电子普通发票”。 增值税电子普通发票一般有机器编码。 校验码数位不一样，增值税电子普通发票校验码是由20位阿拉伯数字组成 ；区块链发票校验码5位数字或英文字母与阿拉伯数字组合。 该增值税发票仅限于中华人民共和国境内使用的增值税发票。 支持的增值税发票包括：增值税专用发票、增值税普通发票、增值税电子专用发票、增值税电子普通发票（含通行费发票、区块链发票）、增值税普通发票（卷票）、全电发票。 如果图片中包含多张卡证票据，请调用智能分类识别服务。

约束与限制 支持JPEG、JPG、PNG、BMP、TIFF、PDF、OFD格式，多页PDF默认识别第一页，或者您可以指定要识别的页码。 图像各边的像素大小在100px到8192px之间。 图像中发票区域有效占比超过80%。 支持图像中增值税发票任意角度的水平旋转。 图片中发票宽高比例与真实发票比例一致。 支持增值税专用发票、全电发票和增值税普通发票（含电子普通发票），包括增值税普通发票中的卷式发票、通行费发票。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

URI POST /v2/{project_id}/ocr/vat-invoice 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

调用API获取项目ID 获取项目ID的接口为“GET https://{endpoint}/v3/projects”，其中“{endpoint}”为IAM的终端节点。接口的认证鉴权请参见认证鉴权。 响应示例如下，例如，文字识别服务部署的区域为“cn-north-4”，响应消息体中查找“name”为“cn-north-4”，其中“projects”下的“id”即为项目ID。获取项目ID报错时，请检查{endpoint}是否填写正确。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/projects { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

响应示例 状态码：200 成功响应示例（人像面） { "result" : { "name" : "张三", "sex" : "男", "ethnicity" : "汉", "birth" : "2000-03-06", "address" : "XX省XX市XX区XX街道XX号", "number" : "610XXXXXXXXXXXXXXX", "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQAB....", "portrait_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD....", "detect_reproduce_result" : true, "detect_copy_result" : true, "verification_result" : { "valid_number" : true, "valid_birth" : true, "valid_sex" : true, "valid_date" : false } } } 成功响应示例（国徽面） { "result" : { "issue" : "XX省XX市XX区XX派出所", "valid_from" : "2004-08-26", "valid_to" : "2034-08-26", "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQAB....", "portrait_image" : "", "verification_result" : { "valid_number" : false, "valid_birth" : false, "valid_sex" : false, "valid_date" : true }, "detect_reproduce_result" : true, "detect_copy_result" : true } } 成功响应示例(双面) { "result" : { "front" : { "name" : "张三", "sex" : "男", "ethnicity" : "汉", "birth" : "1984-27-28", "address" : "杭州市xx区xx街xx路xx号", "number" : "372901xxxxxxxx4358", "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQAB....", "portrait_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD....", "verification_result" : { "valid_number" : true, "valid_birth" : false, "valid_sex" : true }, "detect_reproduce_result" : true, "detect_copy_result" : false, "score_info" : { "reproduce_score" : 49, "copy_score" : 0 } }, "back" : { "issue" : "xx县公安局", "valid_from" : "2006-08-30", "valid_to" : "2016-08-30", "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD....", "verification_result" : { "valid_date" : true, "valid_validity_period" : true }, "detect_reproduce_result" : false, "detect_copy_result" : false, "score_info" : { "reproduce_score" : 23, "copy_score" : 0 } } } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，身份证识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/id-card”，“project_id”为项目ID，获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入身份证图片的base64编码进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件 POST https://{endpoint}/v2/{project_id}/ocr/id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "side" : "front", "return_text_location" : true, "return_verification" : true, "detect_reproduce" : true, "detect_copy" : true } 传入身份证图片的url进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件 POST https://{endpoint}/v2/{project_id}/ocr/id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName", "side" : "front", "return_text_location" : true, "return_verification" : true, "detect_reproduce" : true, "detect_copy" : true }

URI POST /v2/{project_id}/ocr/id-card 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID，您可以从获取项目ID中获取。

约束与限制 支持中华人民共和国居民身份证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在15px到8000px之间。 图像中身份证区域有效占比超过25%，保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的身份证长宽比与实际身份证相差不超过10%。 能处理反光、暗光等干扰的图片但影响识别精度。 目前支持识别单张身份证的正面或者反面。 支持居民身份证的正反面同时识别，不支持存在两张及以上同面身份证的图片识别。

功能介绍 识别身份证图片中的文字内容，并将识别的结果以JSON格式返回给用户。支持身份证翻拍、PS、模糊、反光、边框完整性、边框内异物遮挡、复印件和临时身份证告警功能。 该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。 身份证信息核验请使用人证核身服务。 图1 身份证示例图 身份证识别支持中华人民共和国居民身份证识别。 如果图片中包含多张卡证票据，请调用智能分类识别服务。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8000px。支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0000001079447456.png OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。 side 否 String 检测身份证的人像面或国徽面。 front：身份证人像面 back：身份证国徽面 double_side：身份证双面信息 如果参数值为空或无该参数，系统自动识别，建议填写，准确率更高。 return_verification 否 Boolean 返回校验身份证号等信息的开关，默认false，可选值如下所示： true：返回校验信息 false：不返回校验信息 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域 如果无该参数，系统默认不返回文字块区域。如果输入参数不是Boolean类型，则会报非法参数错误。 return_portrait_image 否 Boolean 返回头像图片信息（base64码）的开关，默认false，可选值如下所示： true ：开启头像图片信息（base64码）的功能 false : 关闭头像图片信息（base64码）的功能 return_adjusted_image 否 Boolean 返回身份证卡面（base64码）的开关，默认false，可选值如下所示： true ：开启身份证卡面（base64码）的功能 false : 关闭身份证卡面（base64码）的功能 return_portrait_location 否 Boolean 返回头像位置信息的开关，默认false，可选值如下所示： true ：开启返回头像位置信息的功能 false : 关闭返回头像位置信息的功能 detect_reproduce 否 Boolean 返回判断身份证图像是否经过翻拍的开关，默认false，可选值如下所示： true ：开启判断身份证图像是否经过翻拍功能 false：关闭判断身份证图像是否经过翻拍功能 detect_copy 否 Boolean 返回判断身份证图像是否是黑白复印件的开关，默认false，可选值如下所示： true ：开启判断身份证图像是否是复印件功能 false : 关闭身份证图像是否是复印件功能 detect_tampering 否 Boolean 身份证图像PS告警功能开关，默认false，可选值如下： true ：开启身份证图像PS告警功能 false : 关闭身份证图像告警功能 detect_border_integrity 否 Boolean 身份证图像边框完整性告警功能开关，默认false，可选值如下： true ：打开身份证图像边框完整性告警功能 false : 关闭身份证图像边框完整性告警功能 detect_blocking_within_border 否 Boolean 身份证图像边框内部是否有异物遮挡的告警功能开关，默认false，可选值如下： true ：开启身份证边框内部异物遮挡告警功能 false : 关闭身份证边框内部异物遮挡告警功能 detect_blur 否 Boolean 身份证图像模糊告警功能的开关，默认false，可选值如下： true ：开启身份证图像模糊告警功能 false : 关闭身份证图像模糊告警功能 detect_interim 否 Boolean 临时身份证告警功能开关，默认false，可选值如下： true ：开启临时身份证告警功能 false : 关闭临时身份证告警功能 detect_glare 否 Boolean 身份证反光告警功能开关，默认false，可选值如下： true ：开启身份证反光告警功能 false : 关闭身份证反光告警功能

响应示例 状态码：200 成功响应示例 { "result" : { "registration_number" : "1234567890A", "name" : "ABC技术有限公司", "type" : "有限责任公司", "address" : "广东省深圳市珞喻路999号", "legal_representative" : "张三", "registered_capital" : "人民币壹佰万元整", "found_date" : "2011年10月18日", "business_term" : "2011年10月18日至2021年10月17日", "business_scope" : "计算机软硬件开发；电脑图文设计(依法须经批准的项目，经相关部门批准后方可开展经营活动)。", "issue_date" : "2011年10月18日", "confidence" : { "registration_number" : "0.9562", "name" : "0.9999", "type" : "0.9631", "address" : "0.9996", "legal_representative" : "0.9256", "registered_capital" : "0.9862", "found_date" : "0.9796", "business_term" : "0.9636", "business_scope" : "0.9584", "issue_date" : "0.9344" } } } 状态码：400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。 例如，营业执照识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/business-license”，“project_id”为项目ID，获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入营业执照图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/business-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入营业执照图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/business-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用OCR服务，账单归到企业ID对应的企业项目中。 携带错误的ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 不携带ID，正常使用OCR服务，账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8192px，支持JPEG、JPG、PNG、BMP、TIFF、PDF格式。多页PDF仅识别第一页。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径，目前支持： 公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。 说明： 接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。