接口文档(新)
更新时间:2026-07-31 19:58:16
1、身份证文字识别
协议说明
本接口用于识别身份证图片中的文字信息,支持身份证正面(人像面)或反面(国徽面)的识别。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/id-ocr-cl |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | string | 是 | 身份证照片,请确保身份证内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,图片类型建议 jpg 格式,1M 左右 |
| imageType | string | 是 | 图片类型,枚举值:URL-图片路径;BASE64-图片 BASE64 编码 |
| ocrType | string | 是 | ocr 类型,0 表示身份证正面,1 表示身份证反面 |
| detectRisk | string | 否 | 是否开启身份证风险类型(身份证复印件)功能,默认不开启,即:false。可选值:true-开启;false-不开启 |
请求示例
{
"image": "https://example.com/idcard.jpg",
"imageType": "URL",
"ocrType": "0",
"detectRisk": "false"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败,请对照状态码 |
| msg | String | 响应 code 码解释 |
| requestId | String | 请求 ID(原 reqId) |
| chargeStatus | Integer | 是否收费,1:收费,0:不收费 |
| data | Object | 返回对象 |
| --tradeNo | String | 交易号,唯一 |
| --address | String | 身份证上地址(仅 ocrType 为 0 时返回) |
| --birth | String | 身份证上出生日期(仅 ocrType 为 0 时返回) |
| --name | String | 身份证上姓名(仅 ocrType 为 0 时返回) |
| --cardNum | String | 身份证编号(仅 ocrType 为 0 时返回) |
| --sex | String | 身份证上性别(仅 ocrType 为 0 时返回) |
| --nation | String | 身份证上民族(仅 ocrType 为 0 时返回) |
| --issuingAuthority | String | 签发机关(仅 ocrType 为 1 时返回) |
| --issuingDate | String | 签发日期(仅 ocrType 为 1 时返回) |
| --expiryDate | String | 有效日期(仅 ocrType 为 1 时返回) |
| --imageStatus | String | 图像状态:normal-识别正常;reversed_side-身份证正反面颠倒;non_idcard-上传的图片中不包含身份证;blurred-身份证模糊;not_complete-身份证不完整;over_dark-欠曝;over_exposure-过曝;unknown-未知状态 |
| --riskType | String | 身份证风险类型,输入参数 detectRisk=true 时,则返回该字段识别身份证类型:normal-正常身份证;copy-复印件 |
| --direction | String | 图像方向:-1-未定义;0-正向;1-逆时针 90 度;2-逆时针 180 度;3-逆时针 270 度 |
返回示例
成功示例:
{
"chargeStatus": 1,
"msg": "成功",
"data": {
"tradeNo": "交易流水号",
"address": "地址",
"birth": "出生日期",
"name": "姓名",
"cardNum": "身份证编号",
"sex": "性别",
"nation": "民族",
"issuingDate": "20061008",
"issuingAuthority": "电二县局",
"expiryDate": "20251008",
"imageStatus": "图像状态",
"direction": "图像方向"
},
"code": "000000",
"requestId": "xxx"
}失败示例:
{
"msg": "系统错误",
"chargeCount": 0,
"code": "301000",
"requestId": "PhcE1222590326496894976",
"chargeStatus": 0
}2、身份证OCRV2
协议说明
本接口用于识别身份证图片中的文字信息(V2版本),自动识别正反面。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/id-ocrV2 |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径,BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/document.png",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败 |
| chargeStatus | Integer | 是否收费,1:收费 0:不收费 |
| chargeCount | Integer | 扣费条数 |
| msg | String | 响应 code 码解释 |
| requestId | String | 流水号(原 reqId) |
| data | Object | 返回对象 |
| --side | String | front 正面,back 背面 |
| --result | Object | 返回结果 |
| ----number | String | 证件号(仅正面返回) |
| ----address | String | 地址(仅正面返回) |
| ----month | String | 出生月份(仅正面返回) |
| ----nation | String | 民族(仅正面返回) |
| ----year | String | 出生年(仅正面返回) |
| ----sex | String | 性别(仅正面返回) |
| ----name | String | 姓名(仅正面返回) |
| ----day | String | 出生日(仅正面返回) |
| ----authority | String | 签发机关(仅背面返回) |
| ----timelimit | String | 身份证有效期(仅背面返回) |
返回示例
正面成功示例:
{
"code": "000000",
"msg": "success",
"requestId": "HcmM1107622401224069120",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"side": "front",
"result": {
"number": "",
"address": "吉林省通榆县八区街团结委六组",
"month": "8",
"nation": "汉",
"year": "2002",
"sex": "男",
"name": "白*",
"day": "20"
}
}
}反面成功示例:
{
"code": "000000",
"msg": "success",
"requestId": "HcmM1107626195328552960",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"side": "back",
"result": {
"authority": "平西路公安博",
"timelimit": "20231205-20410305"
}
}
}3、行驶证OCR
协议说明
本接口用于识别行驶证图片中的文字信息。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/vehicle-license |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径,BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/photo.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败,请对照状态码 |
| msg | String | 响应消息内容 |
| requestId | String | 请求 id(原 reqId) |
| chargeStatus | Integer | 是否收费 |
| chargeCount | Integer | 计费条数 |
| data | Object | 返回对象 |
| --brandModel | String | 品牌型号 |
| --openingDate | String | 发证日期 |
| --usingProperties | String | 使用性质 |
| --engineNo | String | 发动机号码 |
| --plateNo | String | 车牌号 |
| --possessor | String | 所有人 |
| --address | String | 住址 |
| --registrationDate | String | 注册日期 |
| --vin | String | 车辆识别代号 |
| --vehicleType | String | 车辆类型 |
| --code | String | 行驶证检测业务返回码 0 成功,其他失败 |
| --msg | String | 行驶证检测业务返回码对应说明 |
| --tradeNo | String | 交易号,唯一 |
返回示例
成功示例:
{
"code": "000000",
"msg": "成功",
"requestId": "iUPw1155886614683373568",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"brandModel": "奥迪牌FV6481LA**",
"openingDate": "20210608",
"usingProperties": "非营运",
"engineNo": "C9*",
"plateNo": "沪EX**",
"possessor": "张**",
"address": "上海市**",
"registrationDate": "20200819",
"vin": "LFV3B2FYXL3**",
"vehicleType": "小型普通客车",
"code": "0",
"msg": "成功",
"tradeNo": "iUPw1155886614683373568"
}
}4、行驶证OCRV2
协议说明
本接口用于识别行驶证图片中的文字信息(V2版本),支持正副页同时识别。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/vehicle-licenseV2 |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径,BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/image.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败 |
| chargeStatus | Integer | 是否收费,1:收费 0:不收费 |
| chargeCount | Integer | 扣费条数 |
| msg | String | 响应 code 码解释 |
| requestId | String | 流水号(原 reqId) |
| data | Object | 返回对象 |
| --front | Object | 认证结果 - 正页 |
| ----brandModel | String | 品牌型号 |
| ----openingDate | String | 发证日期 |
| ----usingProperties | String | 使用性质 |
| ----engineNo | String | 发动机号码 |
| ----possessor | String | 所有人 |
| ----address | String | 住址 |
| ----registrationDate | String | 注册日期 |
| ----vin | String | 车辆识别代号 |
| ----vehicleType | String | 车辆类型 |
| ----plateNo | String | 号牌号码 |
| --back | Object | 副页 |
| ----plateNo | String | 号牌号码 |
| ----approvedPassenger | String | 核定载人数 |
| ----grossMass | String | 总质量 |
| ----unladenMass | String | 整备质量 |
| ----approvedLoad | String | 核定载质量 |
| ----overallDimension | String | 外廓尺寸 |
| ----tractionMass | String | 准牵引总质量 |
| ----inspectionRecord | String | 检验记录 |
| ----energyType | String | 燃油类型 |
| ----fileNumber | String | 档案编号 |
返回示例
成功示例:
{
"code": "000000",
"msg": "success",
"requestId": "rChA1105432958282293248",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"back": {
"grossMass": "2000kg",
"energyType": "汽油",
"unladenMass": "1550kg",
"fileNumber": "",
"approvedLoad": "1550kg",
"plateNo": "京N9SA65",
"overallDimension": "4490×1877×1675mm",
"tractionMass": "",
"approvedPassenger": "5人",
"inspectionRecord": "检验有效期至2020年05月京A(01)"
},
"front": {
"engineNo": "K022155",
"address": "北京市朝阳区望京中环南路甲2号三层",
"plateNo": "京N9SA65",
"usingProperties": "租赁",
"registrationDate": "2019-05-29",
"brandModel": "宝沃牌BW7140A1X5",
"vin": "LXVJ2GEC4KA019217",
"possessor": "北京神州汽车租赁有限公司",
"openingDate": "2019-05-29",
"vehicleType": "小型轿车"
}
}
}5、驾驶证OCR
协议说明
本接口用于识别驾驶证图片中的文字信息。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/driving-license |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见;支持 URL 或 BASE64;图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL:图片路径;BASE64:图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/document.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败,请对照状态码 |
| msg | String | 响应消息内容 |
| requestId | String | 请求 id(原 reqId) |
| chargeStatus | Integer | 是否收费 |
| chargeCount | Integer | 计费条数 |
| data | Object | 返回对象 |
| --tradeNo | String | 交易号,唯一 |
| --number | String | 证件号 |
| --expiryTime | String | 有效时间 |
| --carType | String | 准驾类型 |
| --address | String | 住址 |
| --name | String | 姓名 |
| --nationality | String | 国籍 |
| --birth | String | 生日 |
| --sex | String | 性别 |
| --firstGetCard | String | 初次领证时间 |
| --code | String | 驾驶证检测业务返回码 0 成功,其他失败 |
| --msg | String | 驾驶证检测业务返回码对应说明 |
返回示例
成功示例:
{
"code": "000000",
"msg": "成功",
"requestId": "iUPw1155886614683373568",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"tradeNo": "22041416073523785",
"code": "0",
"number": "440210********8125",
"expiryTime": "20180314 - 20240314",
"carType": "C1",
"address": "广东省珠海市香洲区行",
"name": "林*",
"nationality": "中国",
"birth": "",
"sex": "女",
"firstGetCard": "20180314"
}
}6、驾驶证OCRV2
协议说明
本接口用于识别驾驶证图片中的文字信息(V2版本),支持正副页同时识别。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/driving-licenseV2 |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径,BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/document.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败 |
| chargeStatus | Integer | 是否收费,1:收费 0:不收费 |
| chargeCount | Integer | 扣费条数 |
| msg | String | 响应 code 码解释 |
| requestId | String | 流水号(原 reqId) |
| data | Object | 返回对象 |
| --front | Object | 认证结果 - 正页 |
| ----id | String | 驾驶证号 |
| ----expiryTime | String | 有效期限 |
| ----carType | String | 准驾类型 |
| ----address | String | 住址 |
| ----name | String | 姓名 |
| ----nationality | String | 国籍 |
| ----birth | String | 出生日期 yyyy-mm-dd |
| ----sex | String | 性别 |
| ----firstGetCard | String | 初次领证时间 |
| ----issueBy | String | 发证单位 |
| --back | Object | 副页 |
| ----fileNumber | String | 档案编号 |
| ----name | String | 姓名 |
| ----id | String | 驾驶证号 |
返回示例
成功示例:
{
"code": "000000",
"msg": "success",
"requestId": "PXzO1104695373564784640",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"back": {
"fileNumber": "370302M9J",
"name": "张昌",
"id": "37030210113"
},
"front": {
"firstGetCard": "200403",
"carType": "C1",
"address": "山东省淄博市淄川区淄城路10号",
"nationality": "中国/CHN",
"issueBy": "山东省淄博市公安局交通警察支队",
"sex": "男",
"expiryTime": "2018-04-03至2024-04-03",
"name": "张",
"birth": "199-297",
"id": "37030219"
}
}
}7、银行卡OCR
协议说明
本接口用于识别银行卡图片中的文字信息。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/bankcard |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径,BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/document.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败,请对照状态码 |
| msg | String | 响应消息内容 |
| requestId | String | 请求 id(原 reqId) |
| chargeStatus | Integer | 是否收费 |
| chargeCount | Integer | 计费条数 |
| data | Object | 返回对象 |
| --tradeNo | String | 交易号,唯一 |
| --cardNum | String | 银行卡账号 |
| --cardType | String | 卡类型(0:未知银行;1:借记卡;2:信用卡;3:预付费卡) |
| --cardName | String | 银行卡名称(建设银行、招商银行等) |
| --validDate | String | 有效期(格式:月/年) |
| --code | String | 银行卡检测业务返回码 0 成功,其他失败 |
| --msg | String | 银行卡检测业务返回码对应说明 |
返回示例
成功示例:
{
"code": "000000",
"msg": "成功",
"requestId": "iUPw1155895260016332800",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"cardNum": "6225 ** ** 3000",
"cardName": "中国工商银行",
"cardType": "2",
"validDate": "07/22",
"code": "0",
"msg": "成功",
"tradeNo": "iUPw1155895260016332800"
}
}8、车牌OCR
协议说明
本接口用于识别车牌图片中的文字信息。
支持的车牌类型:小型汽车、新能源车、大型汽车、挂车、教练车、警车、军车、使领馆车、港澳车。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/vehiclePlateNo |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径,BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/document.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败 |
| chargeStatus | Integer | 是否收费,1:收费 0:不收费 |
| chargeCount | Integer | 扣费条数 |
| msg | String | 响应 code 码解释 |
| requestId | String | 流水号(原 reqId) |
| data | Object | 返回对象 |
| --result | Array | 认证结果,具体见下面映射关系枚举 |
| ----color | String | 车牌颜色,支持 blue、yellow、green、white、black |
| ----number | String | 车牌号 |
返回示例
成功示例:
{
"code": "000000",
"msg": "success",
"requestId": "ofpq1095393838504230912",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"result": [
{
"color": "blue",
"number": "沪C3S9G6"
}
]
}
}9、营业执照OCR
协议说明
本接口用于识别营业执照图片中的文字信息。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/business-license |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 识别图片,请确保内容信息清晰可见。支持 url 或 base64,图片大小不能大于 2M,支持图片类型:jpg/png/bmp |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径,BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/document.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功;500000:失败 |
| msg | String | 响应 code 码解释 |
| requestId | String | 请求 id(原 reqId) |
| chargeStatus | Integer | 是否收费,枚举值:1:收费 0:不收费 |
| chargeCount | Integer | 计费条数 |
| data | Object | 返回对象 |
| --tradeNo | String | 交易号 |
| --code | String | 营业执照识别业务返回码 0 成功,其他失败 |
| --msg | String | 营业执照识别业务返回码对应说明 |
| --number | String | 编号 |
| --address | String | 单位地址 |
| --creditCode | String | 社会信用代码 |
| --validDate | String | 有效时间 |
| --companyName | String | 单位名称 |
| --legalPerson | String | 法人代表 |
| --bussiness | String | 经营范围 |
| --capital | String | 注册资本 |
| --establishDate | String | 注册日期 |
| --type | String | 公司类型 |
返回示例
成功示例:
{
"code": "000000",
"msg": "成功",
"requestId": "rbSb1155875897133531136",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"tradeNo": "rbSb1155875897133531136",
"code": "0",
"msg": "成功",
"number": "无",
"address": "上海市松江区广富林东路199号4幢9-12层",
"creditCode": "913101165727226313",
"validDate": "",
"companyName": "上海创蓝云智信息科技股份有限公司",
"legalPerson": "唐**",
"bussiness": "许可项目:第二类增值电信业务...(依法须经批准的项目,经相关部门批准后方可开展经营活动)",
"capital": "人民币6000.0000万元整",
"establishDate": "2025年10月31日",
"type": "个体工商户"
}
}10、表格文字识别OCR
协议说明
本接口用于识别表格图片中的文字信息,返回表格结构化数据。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/tableOcr |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json 方式提交。
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| image | String | 否 | 图片 base64 串,image、url 二选一。格式为 jpg 或 png,宽和高大于 8px、小于等于 4000px,大小不能超过 1MB |
| url | String | 否 | 图片 url,image、url 二选一。格式为 jpg 或 png,宽和高大于 8px、小于等于 4000px,大小不能超过 1MB |
请求示例
{
"image": "https://example.com/document.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功,其他失败。见附录响应 code 码 |
| msg | String | 响应 code 码解释 |
| chargeStatus | Integer | 是否收费,枚举值:1:收费 0:不收费 |
| chargeCount | Integer | 扣费条数 |
| requestId | String | 请求 Id(原 reqId) |
| data | Object | 返回对象 |
| --fileContent | String | 文件内容 |
| --tables | Array | 表格数据 |
| ----head | Array | 表头信息 |
| ----tableRows | Array | JSON 格式的表格行数据 |
| ------tableColumns | Array | JSON 格式的表格列数据 |
| --------endColumn | Integer | 单元格所占的列数 |
| --------endRow | Integer | 单元格所占的行数 |
| --------height | Integer | 图片上单元格的高度 |
| --------startColumn | Integer | 单元格的起始列 |
| --------startRow | Integer | 单元格的起始行 |
| --------texts | Array | 文本,每行(row)文字为一个 block |
| --------width | Integer | 宽 |
| ----tail | Array | 表尾信息 |
返回示例
成功示例(节选):
{
"code": "000000",
"msg": "success",
"requestId": "cKjP1181286833269776384",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"fileContent": null,
"tables": [
{
"head": [],
"tableRows": [
{
"tableColumns": [
{
"endColumn": 1,
"endRow": 1,
"height": 37,
"startColumn": 0,
"startRow": 0,
"texts": [
"字段名称"
],
"width": 119
}
]
}
],
"tail": null
}
]
}
}11、发票OCR
协议说明
本接口用于识别发票图片中的文字信息。
| 名称 | 说明 |
|---|---|
| 协议 | HTTPS POST |
| 编码格式 | UTF-8 |
| Content-Type | application/json |
| URL | https://wsapi.253.com/api/v2/sdk/ocr/invoiceOcr |
请求头参数
请参考通用请求头
请求参数说明
请求参数 Body 以 application/json(JSON Body)方式提交
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| image | String | 是 | 发票图片,请确保发票内容信息清晰可见。支持 url 或 base64 |
| imageType | String | 是 | 图片类型,枚举值:URL-图片路径;BASE64-图片 BASE64 编码 |
请求示例
{
"image": "https://example.com/document.jpg",
"imageType": "URL"
}请求结果说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | String | 响应 code 码。000000:成功;500000:失败 |
| msg | String | 响应 code 码解释 |
| requestId | String | 请求 id(原 reqId) |
| chargeStatus | Integer | 是否收费,枚举值:1:收费 0:不收费 |
| chargeCount | Integer | 计费条数 |
| data | Object | 返回对象 |
| --antiFakeCode | String | 校验码 |
| --checker | String | 复核人 |
| --clerk | String | 开票人 |
| --invoiceAmount | String | 价税合计 |
| --invoiceCode | String | 发票代码 |
| --invoiceDate | String | 开票日期 |
| --invoiceNo | String | 发票号码 |
| --itemName | Array | 服务名称 |
| --payee | String | 收款人 |
| --payeeAddress | String | 销售方地址 |
| --payeeName | String | 销售方名称 |
| --payeeBankName | String | 销售方开户行及账号 |
| --payeeRegisterNo | String | 销售方纳税人识别号 |
| --payerAddress | String | 购买方地址电话 |
| --payerBankName | String | 购买方开户行及账号 |
| --payerName | String | 购买方名称 |
| --payerRegisterNo | String | 购买方纳税人识别号 |
| --sumAmount | String | 价税合计(大写) |
| --taxAmount | String | 合计税额 |
| --withoutTaxAmount | String | 合计金额 |
返回示例
成功示例:
{
"code": "000000",
"msg": "success",
"requestId": "poPH1123298790189293568",
"chargeStatus": 1,
"chargeCount": 1,
"data": {
"antiFakeCode": "73797400052814574999",
"checker": "谢文雅",
"clerk": "冯晨",
"invoiceAmount": "101.10",
"invoiceCode": "044002300111",
"invoiceDate": "2024年03月03日",
"invoiceNo": "97386849",
"itemName": [
"•化学药品原药*易下开塞露(含甘油)10ml*20支/盒便秘润肠通便儿童老人"
],
"payee": "吕忱",
"payeeAddress": "广州高新技术产业开发区科学城科学大道243号A5栋501房020-28143580",
"payeeBankName": "招行广州林和路支行120909888310608",
"payeeName": "阿里健康大药房医药连锁有限公司",
"payeeRegisterNo": "91440101681325547Y",
"payerAddress": "",
"payerBankName": "",
"payerName": "沈宏",
"payerRegisterNo": "",
"sumAmount": "壹佰零壹圆壹角",
"taxAmount": "11.63",
"withoutTaxAmount": "89.47"
}
}失败示例:
{
"code": "190004",
"msg": "参数错误,图片url路径格式有误,必须以http/https开头",
"requestId": "poPH1123299693042589696",
"chargeStatus": 0,
"data": null
}这篇文档对您有帮助吗?




