功能说明
对各种证件图片进行智能文字识别并结构化输出。无采集功能、不存储用户图片及识别信息
1.支持:PNG、JPG、JPEG、BMP、GIF、TIFF、WebP。暂不支持 PDF 格式
2.图片长宽需要大于 20 像素,小于 8192 像素。文件大小请勿超过2M
3.保证整证件内容及其边缘包含在图像内
4.图片识别结果结构OcrResult
| 名称 |
类型 |
输出 |
说明 |
| 证件识别信息1 | string | - | 证件识别信息字段视类型证件各异,参考具体证件识别方法 |
| 证件识别信息2 | string | - | ... |
| 证件识别信息3 | string | - | ... |
| ... | string | - | ... |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
输出 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
| qualityScore | float | 否 | 整体质量分数,身份证ocr有效 |
| tamperScore | float | 否 | 篡改指数(数值越大表示篡改可能性越大,推荐阈值:60),身份证ocr有效 |
| completenessScore | float | 否 | 完整度评分,身份证ocr有效 |
|
密钥传递方式
密钥token可以通过url参数传递,也可以通过httpheader设置token,url设置的token优先httpheader设置的token
url方式:比如调用地址 http://api.konpn.com:10002/ocrcert/common?type=idcard&token=密钥token
httpheader方式:key="Authorization" value= "密钥Token"
身份证识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/idcard?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
List<OcrResult> |
是 |
OcrResult数据序列,正面反面 最多 2个元素,元素结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| type | string | - | 正面face,反面back |
| name | string | - | 姓名 |
| sex | string | - | 性别 |
| ethnicity | string | - | 民族 |
| birthDate | string | - | 出生日期 |
| address | string | - | 住址 |
| idNumber | string | - | 身份证号码 |
| |
| issueAuthority | double | - | 签发机关(反面信息) |
| validPeriod | double | - | 有效期限(反面信息) |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
| qualityScore | float | 否 | 整体质量分数,身份证ocr有效 |
| tamperScore | float | 否 | 篡改数值大篡改可能性越大推荐阈值60 |
| completenessScore | float | 否 | 完整度评分,身份证ocr有效 |
|
|
请求范例:
返回范例:
驾驶证识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/drivinglicense?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
List<OcrResult> |
是 |
OcrResult数据序列,正面反面 最多 2个元素,元素结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| type | string | - | 正面face,反面back |
| name | string | - | 姓名 |
| sex | string | - | 性别 |
| licenseNumber | string | - | 证号 |
| nationality | string | - | 国籍 |
| address | string | - | 住址 |
| birthDate | string | - | 出生日期 |
| initialIssueDate | string | - | 初次领证日期 |
| approvedType | string | - | 准驾类型 |
| issueAuthority | string | - | 发证单位 |
| validFromDate | string | - | 有效起始日期 |
| validPeriod | string | - | 有效期限 |
| |
| name | string | - | 姓名(反面信息) |
| licenseNumber | string | - | 证号(反面信息) |
| record | string | - | 记录(反面信息) |
| recordNumber | string | - | 档案编号(反面信息) |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
行驶证识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/vehiclelicense?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
List<OcrResult> |
是 |
OcrResult数据序列,正面反面 最多 2个元素,元素结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| type | string | - | 正面face,反面back |
| address | string | - | 住址 |
| engineNumber | string | - | 发动机号码 |
| issueDate | string | - | 发证日期 |
| model | string | - | 品牌型号 |
| owner | string | - | 所有人 |
| licensePlateNumber | string | - | 号牌号码 |
| registrationDate | string | - | 注册日期 |
| useNature | string | - | 使用性质 |
| vehicleType | string | - | 车辆类型 |
| vinCode | string | - | 车辆识别代码 |
| issueAuthority | string | - | 签发机关 |
| |
| licensePlateNumber | string | - | 号牌号码(反面信息) |
| inspectionRecord | string | - | 检验记录(反面信息) |
| passengerCapacity | string | - | 核定载人数(反面信息) |
| totalWeight | string | - | 总质量(反面信息) |
| curbWeight | string | - | 整备质量(反面信息) |
| permittedWeight | string | - | 核定载质量(反面信息) |
| overallDimension | string | - | 外廓尺寸(反面信息) |
| tractionWeight | string | - | 准牵引总质量(反面信息) |
| energySign | string | - | 能源标志(反面信息) |
| recordNumber | string | - | 档案编号(反面信息) |
| remarks | string | - | 备注(反面信息) |
| barcodeNumber | string | - | 条形码编号(反面信息) |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
银行卡识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/bankcard?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
OcrResult |
是 |
结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| cardType | string | - | 卡种 CC(贷记卡),SCC(准贷记卡),DCC(存贷合一卡),DC(储蓄卡),PC(预付卡) |
| bankName | string | - | 银行名称 |
| cardNumber | string | - | 银行卡号 |
| validToDate | string | - | 有效期限 |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
护照识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/passport?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
OcrResult |
是 |
结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| passportType | string | - | 证件类型 |
| surname | string | - | 姓 |
| givenName | string | - | 名 |
| passportNumber | string | - | 护照号码 |
| nationality | string | - | 国家码 |
| nameEn | string | - | 英文姓名 |
| name | string | - | 非英文姓名 |
| sex | string | - | 性别 |
| birthPlaceEn | string | - | 出生地 |
| birthPlace | string | - | 非英文出生地 |
| country | string | - | 国籍 |
| validToDate | string | - | 有效期至 |
| birthDate | string | - | 出生日期 |
| birthDateYmd | string | - | 出生日期-年月日 |
| issueDateYmd | string | - | 签发日期 |
| issuePlaceEn | string | - | 签发地 |
| issuePlace | string | - | 非英文签发地 |
| issueAuthorityEn | string | - | 签发机关 |
| issueAuthority | string | - | 非英文签发机关 |
| idNumber | string | - | 身份号 |
| mrzLine1 | string | - | 机读码一 |
| mrzLine2 | string | - | 机读码二 |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
营业执照识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/businesslicense?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
OcrResult |
是 |
结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| creditCode | string | - | 统一社会信用代码 |
| companyName | string | - | 营业名称 |
| companyType | string | - | 类型 |
| businessAddress | string | - | 营业场所/住所 |
| legalPerson | string | - | 法人/负责人 |
| businessScope | string | - | 经营范围 |
| registeredCapital | string | - | 注册资本 |
| RegistrationDate | string | - | 注册日期 |
| validPeriod | string | - | 营业期限 |
| validFromDate | string | - | 格式化营业期限起始日期 |
| validToDate | string | - | 格式化营业期限终止日期 |
| companyForm | string | - | 组成形式 |
| issueDate | string | - | 发照日期 |
| title | string | - | 证照标题 |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
不动产证识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/estatecert?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
OcrResult |
是 |
结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| area | string | - | 面积 |
| certificateNumber | string | - | 证号 |
| mutualOwnershipState | string | - | 共有情况 |
| obligee | string | - | 权利人 |
| location | string | - | 坐落地址 |
| unitNumber | string | - | 不动产单元号 |
| rightType | string | - | 权利类型 |
| rightProperty | string | - | 权利性质 |
| usage | string | - | 用途 |
| serviceLife | string | - | 使用期限 |
| otherState | string | - | 权利其他状况 |
| buildingArea | string | - | 房屋建筑面积 |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
出生证明识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/birthcert?url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
OcrResult |
是 |
结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| neonatalName | string | - | 新生儿姓名 |
| sex | string | - | 性别 |
| birthTime | string | - | 出生时间 |
| gestationalAge | string | - | 出生孕周 |
| birthWeight | string | - | 出生体重 |
| birthLength | string | - | 出生身长 |
| birthPlace | string | - | 出生地 |
| medicalInstitutions | string | - | 医疗机构名称 |
| motherName | string | - | 母亲姓名 |
| motherAge | string | - | 母亲年龄 |
| motherNationality | string | - | 母亲国籍 |
| motherEthnicity | string | - | 母亲民族 |
| motherAddress | string | - | 母亲住址 |
| motherIdCardNumber | string | - | 母亲有效身份证件号 |
| fatherName | string | - | 父亲姓名 |
| fatherAge | string | - | 父亲年龄 |
| fatherNationality | string | - | 父亲国籍 |
| fatherEthnicity | string | - | 父亲民族 |
| fatherAddress | string | - | 父亲住址 |
| fatherIdCardNumber | string | - | 父亲有效身份证件号 |
| issueAuthority | string | - | 签发机构 |
| issueDate | string | - | 签发日期 |
| certificateNumber | string | - | 编号 |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
户口本识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/household?url=&residentpage=0
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| residentpage |
int |
否 |
是否常住人口页, 默认0 否, 1表示是 |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
OcrResult |
是 |
结构如下表 |
|
| 名称 |
类型 |
输出 |
说明 |
| Registrar | string | - | 承办人签章 |
| address | string | - | 住址 |
| householdNumber | string | - | 户号 |
| householdType | string | - | 户别 |
| householderCommunity | string | - | 户主社区 |
| householderName | string | - | 户主姓名 |
| issueDate | string | - | 签发日期 |
| sectionNo | string | - | 地段号 |
| birthDate | string | - | 出生日期 |
| birthPlace | string | - | 出生地 |
| bloodGroup | string | - | 血型 |
| educationalDegree | string | - | 文化程度 |
| employer | string | - | 服务处所 |
| ethnicity | string | - | 民族 |
| formerName | string | - | 曾用名 |
| idCardNumber | string | - | 身份证编号 |
| immigratedToCityInfo | string | - | 何时何地迁来本市 |
| immigratedToResidenceInfo | string | - | 何时由何地迁来本址 |
| maritalStatus | string | - | 婚姻状况 |
| militaryServiceStatus | string | - | 兵役状况 |
| name | string | - | 姓名 |
| nativePlace | string | - | 籍贯 |
| occupation | string | - | 职业 |
| otherResidence | string | - | 本市其他住址 |
| registrationDate | string | - | 登记日期 |
| relation | string | - | 与户主关系 |
| religious | string | - | 宗教信仰 |
| sex | string | - | 性别 |
| stature | string | - | 身高 |
| |
| imginfo | object | 是 | 图片信息,结构如下 |
|
| 名称 |
类型 |
必填 |
说明 |
| width | int | 是 | 算法矫正图片后的宽度 |
| height | int | 是 | 算法矫正图片后的高度 |
| orgWidth | int | 是 | 原图的宽度 |
| orgHeight | int | 是 | 原图的高度 |
| isCopy | int | 是 | 是否是复印件(1:是,0:否) |
|
|
请求范例:
返回范例:
通用证件识别Ocr
接口地址:http://api.konpn.com:10002/ocrcert/common?type=xxx&url=
请求方式:post
返回类型:json
请求参数:
| 名称 |
类型 |
必填 |
说明 |
| type |
string |
是 |
枚举 idcard,drivinglicense,vehiclelicense,bankcard,passport,businesslicense,estatecert,household,birthcert 分别对应 身份证,驾驶证,行驶证,银行卡,护照,营业执照,不动产证,户口本,出生证明 |
| url |
string |
否 |
网络图片url,通过url传递(body和url二者选填一,url参数优先) |
| body |
stream |
否 |
图片stream,直接填入request stream(body和url二者选填一,url参数优先) |
| token |
string |
是 |
您的密钥 |
返回参数:
| 名称 |
类型 |
输出 |
说明 |
| RequestId |
string |
是 |
调用序号Id |
| Code |
int |
是 |
调用结果,=0调用成功,其他失败失败原因参考Msg |
| Msg |
string |
是 |
失败信息 |
| Data |
string |
是 |
视type类型输出对象的json序列化字符串 结果应按type类型将Data反序列化得出 OcrResult 或 List<OcrResult> 实例 |
请求范例:
返回范例: