金蝶云·苍穹视觉识别服务开放平台自定义服务OpenAPI文档所属产品金蝶云苍穹视觉识别平台所属部门金蝶云苍穹AI与大数据平台部/语音及图像服务部文档作者姚亮当前版本V0.4版本修订日期编写/修订内容更新人审核人v0.12021.01.20创建身份证识别服务和发布本文档姚亮金蝶云苍穹视觉识别平台团队全体v0.22021.01.28创建自定义模板识别服务姚亮金蝶云苍穹视觉识别平台团队全体v0.32022.03.21创建预置模版服务API调用姚亮金蝶云苍穹视觉识别平台团队全体v0.42022.06.211.新增通用文字/驾驶证/护照识别；2.更新错误码姚亮金蝶云苍穹视觉识别平台团队全体版本信息目录1简介2金蝶云•苍穹视觉识别服务OpenAPI请求方法2.1调用方式2.2请求URL2.3请求方式2.4请求参数2.5示例2.6返回参数(JSON字符串)2.6.1输出示例-成功2.6.2输出示例-失败3预置模版服务API详细描述3.1身份证识别(人像面)3.1.1输入参数3.1.2输出参数(data)3.1.3示例3.2身份证识别(国徽面)3.2.1输入参数3.2.2输出参数(data)3.2.3示例3.3银行卡识别3.3.1输入参数3.3.2输出参数(data)3.3.3示例3.4高校学位证识别3.4.1输入参数3.4.2输出参数(data)3.4.3示例3.5高校毕业证识别3.5.1输入参数3.5.2输出参数(data)3.5.3示例3.6离职证明识别3.6.1输入参数3.6.2输出参数(data)3.6.3示例3.7银行回单识别3.7.1输入参数3.7.2输出参数(data)3.7.3示例3.8增值税发票识别（五要素）3.8.1输入参数3.8.2输出参数(data)3.8.3示例3.9护照3.9.1输入参数3.9.2输出参数(data)3.9.3示例3.10驾驶证-正页3.10.1输入参数3.10.2输出参数(data)3.10.3示例3.11通用文字识别3.11.1输入参数3.11.2输出参数(data)3.11.3示例4自定义模板服务API详细描述4.1输入参数4.2输出参数(data)4.3示例5错误码5.1错误码类型说明5.2公共错误码5.3预置模版服务错误码5.4示例识别失败示例5.4.1识别失败输出示例5.4.2平台输出示例6修订与评审6.1修订6.2评审参数名称参数必传类型Header:请求的消息主体编码方式Content-Type:application/json是String用户认证后的访问令牌access_token是StringBody:业务对象标识(苍穹的页面编码)businessObject是String模板编码templateNumber是String图片的Base64值imageData是String1简介本文档描述金蝶云苍穹视觉识别服务的相关OpenApi接口信息2金蝶云•苍穹视觉识别服务OpenAPI请求方法2.1调用方式本服务API采用金蝶云•苍穹开放平台（openApi）外部可编程接口（API）调用方式2.2请求URL服务域名地址/kapi/app/cvp/ocrImageInfo列如:http://localhost:8080/ierp/kapi/app/cvp/ocrImageInfo2.3请求方式POST2.4请求参数2.5示例POSThttp://localhost:8080/ierp/kapi/app/cvp/ocrImageInfoRequestHeader:Content-Type:application/jsonaccess_token:666522411780278272O7e12312ukdaG12338RequestBody:{"businessObject":"cvp_demo","templateNumber":"OPM-IDCardFront","imageData":"9j/4VDuRXhpXXXXXXXXXXXXXXXXXXXXXXXXXXX"}2.6返回参数(JSON字符串)2.6.1输出示例-成功2.6.2输出示例-失败3预置模版服务API详细描述3.1身份证识别(人像面)本接口用于身份证人像面识别。3.1.1输入参数参数:模板编码(templateNumber)为固定值{"data":{"address":"浙江省桐庐县凤川镇XXXXX","nation":"汉","sex":"男","name":"王青X","birth":"1981/02/21","idNum":"33012344556787899813344"},"message":"ok","errorCode":"0","success":true}{"success":false,"error_desc":"未经授权的访问。","error_code":1}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-IdCardBack方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明nameString姓名sexString性别nationString民族birthString出生日期addressString地址idNumString身份证号3.1.2输出参数(data)3.1.3示例输出示例{"data":{"address":"浙江省桐庐县凤川镇上XXXXX","nation":"汉","sex":"男","name":"王青X","birth":"1981/02/21","idNum":"33232301221232122323913"},"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-IDCardFront方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明authorityString发证机关validDateString证件有效期3.2身份证识别(国徽面)本接口用于身份证国徽面识别。3.2.1输入参数参数:模板编码(templateNumber)为固定值3.2.2输出参数(data)3.2.3示例输出示例3.3银行卡识别本接口用于银行卡识别。{"data":{"validDate":"2017.11.03-2027.11.03","authority":"深圳市公安局南山分局"},"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-BankCard方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明bankInfoString银行信息validDateString有效期cardNoString卡号3.3.1输入参数参数:模板编码(templateNumber)为固定值3.3.2输出参数(data)3.3.3示例输出示例3.4高校学位证识别本接口用于高校学位证识别，目前仅支持中国大陆高校的学位证识别。{"data":{"bankInfo":"武汉农村商业银行","validDate":"88/88","cardNo":"6251568888888888"},"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-CertificateOfDegree方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明nameString学生姓名degreeCertificationIdString学位证编号educationString学历disciplineString专业degreeString学位schoolString学校名3.4.1输入参数参数:模板编码(templateNumber)为固定值3.4.2输出参数(data)3.4.3示例输出示例参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-Diploma方法入参3:业务对象标识(图片的Base64值)imageData是String3.5高校毕业证识别本接口用于毕业证识别，目前仅支持中国大陆高校的毕业证识别。3.5.1输入参数参数:模板编码(templateNumber)为固定值3.5.2输出参数(data){"data":{"degree":"管理学学士","degreeCertificationId":"1234567788","discipline":"市场营销","education":"本科","name":"张三","school":"武汉理工大学"},"message":"ok","errorCode":"0","success":true}参数名称类型说明nameString学生姓名diplomaIdString毕业证编号startYearString入学年月endYearString毕业年月yearsString学制disciplineString专业educationString学历schoolString学校名3.5.3示例输出示例3.6离职证明识别本接口用于离职证明识别，仅支持中文离职证明的识别。3.6.1输入参数参数:模板编码(templateNumber)为固定值{"data":{"diplomaId":"1284612333203005381557","discipline":"电机电器智能化","education":"本科","endYear":"2030年05月","name":"牛翌","school":"湘潭医卫职业技术学院","startYear":"2025年07月","years":"5"},"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-CertificateOfResignation方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明companyString公司名userNameString姓名departmentString部门idcardString身份证号entryDateString入职日期leaveDateString离职日期positionString职位leaveReasonString离职原因3.6.2输出参数(data)3.6.3示例输出示例{"data":{"company":"东莞伟X达电子产品有限公司","department":"品质管理部","entryDate":"2008年11月19日","idcard":"1232332110073437","leaveDate":"2009年12月31日","leaveReason":"个人原因","position":"高级校对员","userName":"李X波"},"message":"ok","errorCode":"0",参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-BankReceipt方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明errorInfoString模板识别错误信息，识别成功则为空othersInfoString当前回单为请求中文件中的第几张回单recongnizeDetailobject当前回单OCR识别结果详细信息recongnizeStatusboolean当前回单识别成功状态。true表示为成功，false表示失败bboxobject当前银行回单在图片中的位置3.7银行回单识别本接口用于银行回单识别，仅支持国内主流银行的银行回单识别。3.7.1输入参数参数:模板编码(templateNumber)为固定值3.7.2输出参数(data)recongnizeDetail中字段说明"success":true}参数名称类型说明tradeIdString银行流水号fpayeeNameString收款人户名fpayeeAccountString收款人账号fpayeeBankString收款方开户行fpaymentNameString付款人户名fpaymentAccountString付款人账号fpaymentBankString付款方开户行ftradeDateString交易日期famountString交易金额fcurrencyString业务币别ftradeNumberString业务参考号fabstractString摘要或者备注信息fuseString用途ftradeTypeString借贷方向字段名字类型说明xminint银行回单在图片中的位置信息xminxmaxint银行回单在图片中的位置信息xmaxyminint银行回单在图片中的位置信息yminymaxint银行回单在图片中的位置信息ymaximageHeightint输入图片的高imageWidthint输入图片的宽bbox中字段说明3.7.3示例输出示例{"data":[{"bbox":{"xmax":3813,"xmin":39,"ymax":2331,3.8增值税发票识别（五要素）本接口用于增值税发票识别（五要素）识别，目前仅支持票面上的五种基本要素识别。3.8.1输入参数参数:模板编码(templateNumber)为固定值"ymin":527,"imageHeight":1024,"imageWidth":2015},"errorInfo":"","othersInfo":"ticket0","recongnizeDetail":{"fabstract":"****","famount":"321,148.56","fcurrency":"人民币","fpayeeAccount":"3510133551001050012745","fpayeeBank":"***********","fpayeeName":"厦门ss集团股份有限公司","fpaymentAccount":"22132133960055560","fpaymentBank":"***********","fpaymentName":"厦门XX集团股份有限公司","ftradeDate":"2020年09月03日","ftradeId":"35100ss0602ww20KWXL","ftradeNumber":"***********","ftradeType":"借","fuse":"****"},"recongnizeStatus":true}],"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-Invoice方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明fpdmString开票代码fphmString开票号码kprqString开票日期fpjeString不含税金额jymString校验码后六位invoiceTypeString发票类型，01：增值税专用发票；04：增值税普通发票；10：增值税电子普通发票sealFlagString是否有印章1:有；0:无3.8.2输出参数(data)3.8.3示例输出示例{"data":{"fpdm":"41021330","fphm":"0112312212","fpje":"41282.05","invoiceType":"01","jym":"2345","kprq":"20171201","sealFlag":"1"},"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-Passport方法入参3:业务对象标识(图片的Base64值)imageData是String3.9护照本接口仅支持中国大陆护照的识别。3.9.1输入参数参数:模板编码(templateNumber)为固定值3.9.2输出参数(data)参数名称类型说明countryCodeString国家码issuePlaceString护照签发地点MRZCode1StringMRZCode1MRZCode2StringMRZCode2expiryDateString有效期⾄authorityString签发机关passportNumberString护照号码issueDateString签发⽇期birthPlaceString出⽣地点nameString姓名nameOfPinyinString姓名（拼⾳）nationalityString国籍birthDateString⽣⽇sexString性别3.9.3示例输出示例{"data":{"passportNumber":"1231232","MRZCode2":"08038F2110189NGKELMPONBPJB978","firstNameOfPinyin":"","sex":"女/F","birthDate":"19810803","expiryDate":"20211018","birthPlace":"北京/BEIJING","nameOfPinyin":"ZHENGJIANG","familyNameOfPinyin":"","nationality":"中国/CHINESE","countryCode":"CHN","authority":"公安部出入境管理局","name":"证件样z","issueDate":"20111019","issuePlace":"山东/SHANDONG","MRZCode1":"POCHN<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<"},"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-DrivingLicenseFront方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明cardNumberString证号nameString姓名sexString性别nationalityString国籍addressString住址birthDateString出生日期issueDateString初次领证日期drivingClassString准驾车型authorityString发证单位expiryDateString有效期限3.10驾驶证-正页本接口用于支持驾驶证的正页信息识别。3.10.1输入参数参数:模板编码(templateNumber)为固定值3.10.2输出参数(data)参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是StringOPM-GeneralSpotting方法入参3:业务对象标识(图片的Base64值)imageData是String3.10.3示例输出示例3.11通用文字识别本接口用于通用文字识别。3.11.1输入参数参数:模板编码(templateNumber)为固定值{"data":{"expiryDate":"20150518-20210518","address":"辽宁省大连市甘井子区XXX","nationality":"中国","drivingClass":"C1","sex":"女","authority":"北京市公安局公安交通管理局","name":"王X桃","issueDate":"20150518","birthDate":"19880929","cardNumber":"12345679294228"},"message":"ok","errorCode":"0","success":true}参数名称类型描述words_resultList[Dict]所有文字区域的检测识别结果combined_resultString所有文字识别结果字符串的拼接words_result_numint图像中检测到的文本区域总数wordsString文字识别内容locationDict文字检测位置信息probabilityList[float]每个字的对应识别置信度left_bottomDict文字区域的左下点left_topDict文字区域的左上点right_bottomDict文字区域的右下点right_topDict文字区域的右上点xint水平坐标，原点为图像左上角yint垂直坐标，原点为图像左上角3.11.2输出参数(data)3.11.3示例输出示例{"data":{"words_result":[{"location":{"left_bottom":{"x":12,"y":64},"left_top":{"x":12,"y":47},"right_bottom":{"x":136,"y":64},"right_top":{"x":136,"y":47}},"probability":[0.99998939037323,0.9999988079071045,0.9993472695350647,0.9999967813491821,0.9994257688522339,0.9999740123748779,0.9999990463256836,0.9999895095825195,0.9999756813049316,0.9997672438621521,0.9999909400939941,0.8052279353141785,0.9999905824661255,0.9999314546585083,0.9999995231628418],"words":"显示日期:2021-08-17"},{"location":{"left_bottom":{"x":219,"y":162},"left_top":{"x":218,"y":134},"right_bottom":{"x":414,"y":161},"right_top":{"x":413,"y":132}},"probability":[0.9999998807907104,0.9999971389770508,0.9999001026153564,1,0.9999995231628418,0.9994353652000427,0.9999383687973022,0.9999996423721313],"words":"电子银行承兑汇票"}],"words_result_num":2,"combined_result":"显示日期:2021-08-17\n\r电子银行承兑汇票"},"message":"ok","errorCode":"0","success":true}参数名称参数必传类型值Header:请求的消息主体编码方式Content-Type是Stringapplication/json用户认证后的访问令牌access_token是StringBody:方法入参1:业务对象标识(苍穹的页面编码)businessObject否String若无苍穹单据；默认传ai-cvp方法入参2:业务对象标识(模板编码)templateNumber是String方法入参3:业务对象标识(图片的Base64值)imageData是String参数名称类型说明recognitionAreaObject文本识别信息对象+自定义识别字段识别标注的字段tableObject表格识别信息对象(可以多个表,{}'表名1':[],'表名1':[]})+表头(表个对象第一个数组值)String[]表头+表格识别信息识别标注的表体信息4自定义模板服务API详细描述本接口用于自定义模板识别。4.1输入参数参数:模板编码(templateNumber)为创建自定义模版生成的编码4.2输出参数(data)4.3示例输出示例{"data":{"recognitionArea":{"件数":"175","海关编号":"230210000021942","申报日期":"20210305","编号":"120210000021942"},"table":{"表格1":[["商品编号","商品名称","规格型号","数量","单位","数量1","单价","总价","币别"],["847290210","D打孔机","3|0|用于文件装订打孔|STAPLES26614-NAUJS\n/10573-NALJS","5778","台","1042","千克\n5778台","0.9550","5518.06","美元"],["****","云之家","云之家","****","****","****","****","4385","4385","%4385"]],"表格2":[["原产地","目的地","征免"],["中国\n(CHN)","中国\n(CHN)","(32069)南通其他照章征税\n(1)"]],"表格3":[["列1","列2","列3"],["385","1","185家"],["12","85","33家"]]}},"message":"ok","errorCode":"0","success":true}5错误码5.1错误码类型说明*系统型错误类型：三位错误码，如500*统一业务错误类型：五位错误码200XX5.2公共错误码响应码描述0响应成功500服务内部错误，请稍后再试或联系管理员。20000OCR服务识别失败，请稍后再试或联系管理员。20001文字检测错误，请稍后再试或联系管理员。20002参数错误，请检查后重新尝试。20003参数取值错误，请检查后重新尝试。20004图片保存失败，请检查后重新尝试。20005URL参数错误，请检查后重新尝试。20006上传的文件格式错误，请检查后重新尝试。20007文件下载失败，请检查后重新尝试。20008文件内容为空，请检查后重新尝试。20009图片模糊，请检查后重新尝试。20010上传的图片大小不符合要求，请检查后重新尝试20011未识别到卡证信息，请确认文件中包含对应卡证。20012图片尺寸过小，建议分辨率大于400x400。20013解码失败，请确认参数中是否包含文件，且文件完整。20014解码失败，请确认参数中是否包含图像，且图像完整。20016PDF文件错误，请检查后重新尝试。20017上传的图片大小不符合要求，现阶段我们支持的图片大小为：base64编码后小于8M，分辨率不高于4096*4096，请重新上传图片。20018无法识别，请检查图片类型是否匹配或图片是否清晰后重新上传。30001识别异常，请检查图片类型是否匹配或图片是否清晰后重新上传。40000微服务接口调用异常40001无视觉识别服务许可权限40002微服务接口参数错误40003自定义模版未发布5.3预置模版服务错误码响应码服务类型描述501增值税发票非法访问1000增值税发票您上传的图像文件为空文件1001增值税发票您上传的文件格式不符合要求1002增值税发票图像尺寸不符合要求，请上传大图1003增值税发票请您上传有效且清晰彩色增值税发票图像1004增值税发票未找到目标发票区域，请您将发票扫描或置于纯色背景中并拍全1005增值税发票请您确认上传了有效且清晰的增值税发票图像，请将发票扫描或置于纯色背景中并拍全1006增值税发票识别失败1007增值税发票下载文件失败1008增值税发票您请求了不支持的发票类型10000银行回单参数错误10001银行回单请求文件错误，请检查后重新尝试10002银行回单请求文件转图片后太小，请更换文件后重新尝试10003银行回单请求文件转图片后为单通道图片，请更换文件后重新尝试响应码服务类型描述10004银行回单请求文件页面超过1页，请更换文件后重新尝试.10005银行回单文件下载失败,图像过大或网络受限，请确认后重试10006银行回单图片解码失败,请确认参数中是否包含图像，且图像完整10007银行回单图片格式错误10008银行回单图片保存失败10009银行回单图片url地址错误10010银行回单识别结果保存失败30101身份证正反身份证正反面参数错误，只能为[FRONT,BACK]。30201银行卡识别银行卡错误，出现此问题的原因一般为：您上传的图片非银行卡正面，上传了异形卡的图片、上传的银行卡正面图片不完整或模糊。30301离职证明关键信息抽取存在异常，请稍后再试或联系管理员。30302离职证明未识别到离职证明相关信息，请检查后重新尝试。5.4示例识别失败示例5.4.1识别失败输出示例5.4.2平台输出示例{"message":"参数:businessObject业务对象标识在系统中不存在,请传有效标识","errorCode":"40002","success":false}6修订与评审6.1修订本文档由金蝶云苍穹AI与大数据平台部负责修订。编写/修订人员是项目的负责人（项目经理）、项目技术负责人，软件设计人员或者由项目负责人指定人员，编写/修订人员填写修订记录。6.2评审本文档由金蝶云苍穹AI与大数据平台部负责修订。审核人员是项目的负责人(项目经理)、项目技术负责人，评审人员填写评审记录。{"success":false,"error_desc":"未经授权的访问。","error_code":1}
