API接口

1、 身份证文字识别

1.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/i/ocr/id-ocr-cl

1.2、请求参数

参数名称	说明
appId	请在 api.253.com 登录后获取
appKey	请在 api.253.com 登录后获取
imageType	图片类型，枚举值：URL-图片路径 ,BASE64 –图片 BASE64 编码
image	身份证识别的照片,说明：imageType 为 BASE64 时，传入照片的 base64 字符编码，base64 字符串不包含 data:image 前缀，图片类型建议 jpg 格式，建议 1M 以内。图片大小不能大于 2M
ocrType	区分身份证正反面参数（ocrType=0 为正面；ocrType=1 为反面）
detectRisk	是否开启身份证风险类型(身份证复印件)功能，默认不开启，即：false。可选值:true-开启；false-不开启

1.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	流水号
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
data	Object
tradeNo	String	交易号，唯一。样例：18041109215057630
riskType	String	身份证风险类型，输入参数detect_risk=true时，则返回该字段识别身份证类型，normal-正常身份证，copy-复印件
name	String	姓名
cardNum	String	身份证号
birth	String	生日
sex	String	性别
nation	String	民族
address	String	地址
issuingAuthority	String	签发机关
issuingDate	String	签发日期
expiryDate	String	有效日期
imageStatus	String	图像状态,normal-识别正常，reversed_side-身份证正反面颠倒，non_idcard-上传的图片中不包含身份证，blurred-身份证模糊，other_type_card-其他类型证照,not_complete-身份证不完整，over_dark-欠曝，over_exposure-过曝，unknown-未知状态
direction	String	图像方向 -1-未定义，0-正向，1-逆时针 90 度，2-逆时针 180 度，3-逆时针 270 度

2、 身份证OCRV2

2.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://wsapi.253.com/open/ocr/id-ocrV2

2.2、请求参数

参数名称	说明
appId	请在 api.253.com 登录后获取
appKey	请在 api.253.com 登录后获取
imageType	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码
image	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp

2.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	流水号
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
chargeCount	String	扣费条数
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	身份证有效期（仅背面返回）

2.4、响应示例

• 请求正面-结果示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "HcmM1107622401224069120",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "side": "front",
        "result": {
            "number": "",
            "address": "吉林省通榆县八区街团结委六组",
            "month": "8",
            "nation": "汉",
            "year": "2002",
            "sex": "男",
            "name": "白添城",
            "day": "20"
        }
    }
}

• 请求背面-结果示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "HcmM1107626195328552960",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "side": "back",
        "result": {
            "authority": "平西路公安博",
            "timelimit": "20231205-20410305"
        }
    }
}

3、 行驶证文字识别V2

3.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	[https://wsapi.253.com/open/ocr/vehicle-licenseV2

3.2、请求参数

参数名称	说明
appId	请在 api.253.com 登录后获取
appKey	请在 api.253.com 登录后获取
image	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp
imageType	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码

3.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
chargeStatus	Integer	是否收费，1 ：收费 0：不收费
chargeCount	String	扣费条数
message	String	响应code码解释
reqId	String	流水号
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	String	副页
++plateNo	String	号牌号码
++approvedPassenger	String	核定载人数
++grossMass	String	总质量
++unladenMass	String	整备质量
++approvedLoad	String	核定载质量
++overallDimension	String	外廓尺寸
++tractionMass	String	准牵引总质量
++inspectionRecord	String	检验记录
++energyType	String	燃油类型
++fileNumber	String	档案编号

• 请求成功-结果示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "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": "小型轿车"
        }
    }
}

• 请求失败-结果示例

复制成功
{
    "code": "500604",
    "success": false,
    "message": "通道异常",
    "chargeStatus": 0
}

4、 驾驶证文字识别V2

4.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	[https://wsapi.253.com/open/ocr/driving-licenseV2

4.2、请求参数

参数名称	说明
appId	请在 api.253.com 登录后获取
appKey	请在 api.253.com 登录后获取
image	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp
imageType	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码

4.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
chargeStatus	Integer	是否收费，1 ：收费 0：不收费
chargeCount	String	扣费条数
message	String	响应code码解释
reqId	String	流水号
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	String	副页
++fileNumber	String	档案编号
++name	String	姓名
++id	String	驾驶证号

• 请求成功-结果示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "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"
        }
    }
}

• 请求失败-结果示例

复制成功
{
    "code": "500604",
    "success": false,
    "message": "通道异常",
    "chargeStatus": 0
}

5、 车牌文字识别OCR

5.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	[https://wsapi.253.com/open/ocr/vehiclePlateNo

5.2、请求参数

参数名称	说明
appId	请在 api.253.com 登录后获取
appKey	请在 api.253.com 登录后获取
image	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp
imageType	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码

5.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
chargeStatus	Integer	是否收费，1 ：收费 0：不收费
chargeCount	String	扣费条数
message	String	响应code码解释
reqId	String	流水号
data	Object	返回对象
+result	Array	认证结果 具体见下面映射关系枚举
++color	String	车牌颜色，支持blue、yellow、green、white、black
++number	String	车牌号

• 请求成功-结果示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "ofpq1095393838504230912",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
      "result": [
            {
               "color": "blue",
               "number": "沪C3S9G6"
             }
       ]
    }
}

• 请求失败-结果示例

复制成功
{
    "code": "500604",
    "success": false,
    "message": "通道异常",
    "chargeStatus": 0
}

6、 境外护照OCR识别

6.1. 护照上传接口

6.1.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	multipart/form-data
URL	https://wsapi.253.com/open/ocr/uploadImage

6.1.2、请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://www.chuanglan.com/登录后获取
appKey	String	是	请在https://www.chuanglan.com/登录后获取
file	MultipartFile	是	护照图片文件
type	String	是	护照类型：1：港澳台地区及境外护照、2：港澳台居民居住证、3：港澳台居民来内地通行证、4：内地往港澳台通行证

6.1.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	流水号
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
data	Object	返回对象
msg	String	错误提示信息
code	String	- 0001 找不到这个 appkey、- 0003 只支持最大 1M 文件的上传，视频只支持最大10M 文件的上传!该图片格式只支持 JPG（JPEG），BMP，PNG，GIF，TIFF,视频格式只支持.mp4, .avi, .flv, .wmv, .mov, .rm、- 0002 无法解析该图片格式!、- 0004 上传失败、- 0000 上传成功
data	String	返回图片标识，用于后续 API 接口调用作入参

6.1.4、响应示例

• • 查询成功示例：

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4233974209294721085",
    "chargeStatus": 0,
    "data": {
        "msg": "上传成功",
        "code": "10000",
        "data": "wm2767874ff94ef68272644338f3dfcc"
    }
}

• 查询失败示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4233974209294721089",
    "chargeStatus": 0,
    "data": {
        "msg": "该图片格式只支持JPG（JPEG），BMP，PNG，GIF，TIFF,视频格式只支持.mp4, .avi, .flv, .wmv, .mov, .rm",
        "code": "10003",
        "data": null
    }
}

6.2 护照识别接口

6.2.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	multipart/form-data
URL	https://wsapi.253.com/open/ocr/passPortOCR

6.2.2、请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://www.chuanglan.com/登录后获取
appKey	String	是	请在https://www.chuanglan.com/登录后获取
imageId	String	是	图片ID，护照上传接口返回的data字段
type	String	是	护照类型：1：港澳台地区及境外护照、2：港澳台居民居住证、3：港澳台居民来内地通行证、4：内地往港澳台通行证

6.2.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	流水号
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
chargeCount	String	计费条数
data	Object	返回对象
id	String	护照ID
name	String	姓名
dateOfBirth	String	出生日期
sex	String	性别（F女，M男）
dateOfExpiration	String	有效期
issuingCountry	String	发行国
nationality	String	国家地区代码
warn	String	告警码 -9103 证照翻拍告警-9102 证照复印件告警（包括黑白复印件、彩色复印件） -9106 证件遮挡告警
advancedInfo	String	扩展字段
codeSet	String	最下方第一行 MRZ Code 序列
codeCrc	String	最下方第二行 MRZ Code 序列
surname	String	姓
givenName	String	名
passportRecognizeInfos	Object	信息区证件内容
dateOfIssuance	String	发行日期（护照信息页识别结果）
issuePlace	String	签发地点（护照信息页识别结果） 仅中国大陆护照支持返回此字段，港澳台及境外护照不支持
issuingAuthority	String	签发机关（护照信息页识别结果） 仅中国大陆护照支持返回此字段，港澳台及境外护照不支持
passportID	String	护照号码（护照信息页识别结果）
signature	String	持证人签名（护照信息页识别结果） 仅中国大陆护照支持返回此字段，港澳台及境外护照不支持
type	String	证件类型（护照信息页识别结果）

• • 查询成功示例：

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4233974209294721202",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "issuingCountry": "CHN",
        "dateOfExpiration": "20260912",
        "passportRecognizeInfos": {
            "issuingCountry": "CHN",
            "issuePlace": "湖北/HUBEI",
            "dateOfIssuance": "13 9月/SEP 2016",
            "passportID": "XXXXXXXXXXXX",
            "dateOfExpiration": "12 9月/SEP 2026",
            "dateOfBirth": "20 JUL 1994",
            "nationality": "中国/CHINESE",
            "surname": "",
            "givenName": "",
            "type": "P",
            "sex": "男/M",
            "issuingAuthority": "公安部出入境管理局\nMPS Exit& Entry Administration",
            "signature": "XXXXXX",
            "name": "XXXXXX"
        },
        "dateOfBirth": "19940720",
        "nationality": "CHN",
        "codeSet": "XXXXXXXXXXXXXXXXXX<<<<<<<<<<<<<<<<<<<<<<<<<<<<",
        "warn": [
            -9102,
            -9103
        ],
        "advancedInfo": "{\"Sex\":{\"Confidence\":\"1.0000\"},\"Name\":        {\"Confidence\":\"0.9998\"},\"IssuingCountry\":{\"Confidence\":\"0.9998\"},\"GivenName\":{\"Confidence\":\"0.9998\"},\"Surname\":{\"Confidence\":\"0.9998\"},\"Type\":{\"Confidence\":\"0.9998\"},\"CodeSet\":{\"Confidence\":\"0.9998\"},\"Nationality\":{\"Confidence\":\"1.0000\"},\"ID\":{\"Confidence\":\"1.0000\"},\"CodeCrc\":{\"Confidence\":\"1.0000\"},\"DateOfBirth\":{\"Confidence\":\"1.0000\"},\"DateOfExpiration\":{\"Confidence\":\"1.0000\"},\"PassportRecognizeInfos\":{\"Type\":{\"Confidence\":\"1.0000\"},\"Sex\":{\"Confidence\":\"1.0000\"},\"Name\":{\"Confidence\":\"1.0000\"},\"IssuingAuthority\":{\"Confidence\":\"1.0000\"},\"IssuePlace\":{\"Confidence\":\"0.9822\"},\"Nationality\":{\"Confidence\":\"1.0000\"},\"IssuingCountry\":{\"Confidence\":\"1.0000\"},\"DateOfBirth\":{\"Confidence\":\"0.9999\"},\"DateOfIssuance\":{\"Confidence\":\"1.0000\"},\"DateOfExpiration\":{\"Confidence\":\"1.0000\"},\"PassportID\":{\"Confidence\":\"1.0000\"},\"Signature\":{\"Confidence\":\"1.0000\"}}}",
        "codeCrc": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "givenName": "XXXXXX",
        "surname": "XXXXXX",
        "id": "E86913973",
        "type": "PO",
        "sex": "M",
        "name": "XXXXXX"
    }
}

• 查询失败示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4233974209294721203",
    "chargeStatus": 0,
    "chargeCount": "0",
    "data": null
}

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	流水号
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
chargeCount	String	计费条数
data	Object	返回对象
address	String	地址
authority	String	签发机关
idCardNo	String	身份证号
sex	String	性别
birth	String	出生日期
cardType	String	0-正面，1-反面
validDate	String	证件有效期限
visaNum	String	签发次数
passNo	String	通行证号码
name	String	证件姓名

• 查询成功示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4279011161960366767",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "address": "北京市西城区复兴门外大街999号院11号楼3单元502室",
        "authority": "",
        "idCardNo": "810000199408230021",
        "sex": "女",
        "birth": "1994/8/23",
        "cardType": "0",
        "validDate": "",
        "visaNum": "0",
        "passNo": "",
        "name": "金鑫"
    }
}

• 查询失败示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4279011161960366769",
    "chargeStatus": 0,
    "chargeCount": "0",
    "data": null
}

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	流水号
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
chargeCount	String	计费条数
data	Object	返回对象
type	String	证件类别， 如：台湾居民来往大陆通行证、港澳居民来往内地通行证。
number	String	证件号
sex	String	性别
birthday	String	出生日期
validDate	String	有效期限
englishName	String	英文姓名
issueAddress	String	签发地点
issueNumber	String	签发次数
issueAuthority	String	签发机关
name	String	中文姓名

• 查询成功示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4279011161960366770",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "type": "港澳居民来往内地通行证",
        "number": "H12345678",
        "sex": "女",
        "birthday": "1981.08.03",
        "validDate": "2012.12.12-2022.12.11",
        "englishName": "ZHENGJIAN,YANGBEN",
        "issueAddress": "",
        "issueNumber": "00",
        "issueAuthority": "公安部出入境管理局",
        "name": "证件样本"
    }
}

• 查询失败示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4279011161960366769",
    "chargeStatus": 0,
    "chargeCount": "0",
    "data": null
}

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	流水号
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
chargeCount	String	计费条数
data	Object	返回对象
number	String	证件号
sex	String	性别
birthday	String	出生日期
validDate	String	有效期限
englishName	String	英文姓名
issueAddress	String	签发地点
issueAuthority	String	签发机关
name	String	姓名

• 查询成功示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4279011161960366771",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "number": "CA3273201",
        "sex": "女",
        "birthday": "1981.08.03",
        "validDate": "2019.01.18-2029.01.17",
        "englishName": "ZHENGJIAN,YANGBEN",
        "issueAddress": "广东",
        "issueAuthority": "中华人民共和国出入境管理局",
        "name": "证件样本"
    }
}

• 查询失败示例

复制成功
{
    "code": "200000",
    "message": "success",
    "reqId": "4279011161960366769",
    "chargeStatus": 0,
    "chargeCount": "0",
    "data": null
}

7、 行驶证OCR（单面）

7.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/i/ocr/vehicle-license

7.2、请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://www.chuanglan.com/登录后获取
appKey	String	是	请在https://www.chuanglan.com/登录后获取
image	string	是	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp
imageType	String	是	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码

7.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	请求id
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
data	Object	返回对象
tradeNo	String	交易号，唯一。样例：18041109215057630
brandModel	String	品牌型号
openingDate	String	发证日期
usingProperties	String	使用性质
engineNo	String	发动机号码
possessor	String	所有人
address	String	住址
registrationDate	String	注册日期
vin	String	车辆识别代号
vehicleType	String	车辆类型
plateNo	String	车牌号
msg	String	行驶证检测业务返回码对应说明（现调用时没有返回）
code	String	行驶证检测业务返回码 0 成功，其他失败

7.4、响应示例

• • 查询成功示例：

复制成功
{
    "chargeStatus": 1,
    "message": "成功",
    "reqId": "iUPw1175886684683373568",
    "data": {
        "tradeNo": "1267539500674842624",
        "code": "0",
        "brandModel": "新本*****",
        "openingDate": "20220721",
        "usingProperties": "非营运",
        "engineNo": "M34L*****",
        "possessor": "陈**",
        "address": "上海市*****",
        "registrationDate": "20220721",
        "vin": "LM0LBV119M1502543",
        "vehicleType": "轻便二轮摩托车",
        "plateNo": "沪EBH****"
    },
    "code": "200000"
}

• 查询失败示例

复制成功
{
    "code": "500000",
    "success": false,
    "message": "系统异常",
    "chargeStatus": 0
}

8、 驾驶证文字识别

8.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/i/ocr/driving-license

8.2、请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://www.chuanglan.com/登录后获取
appKey	String	是	请在https://www.chuanglan.com/登录后获取
image	string	是	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp
imageType	String	是	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码

8.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	请求id
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
data	Object	返回对象
tradeNo	String	交易号，唯一。样例：18041109215057630
number	String	证件号
expiryTime	String	有效时间
carType	String	准驾类
address	String	住址
name	String	姓名
nationality	String	国籍
birth	String	生日
sex	String	性别
firstGetCard	String	初次领证时间
msg	String	驾驶证检测业务返回码对应说明(现在调用时没有返回)
code	String	驾驶证检测业务返回码 0 成功，其他失败

8.4、响应示例

• • 查询成功示例：

复制成功
{
    "chargeStatus": 1,
    "message": "成功",
    "reqId": "iUPw1155886614683373568",
    "data": {
        "tradeNo": "22041416073523785",
        "code": "0",
        "number": "440210********8125",
        "expiryTime": "20180314 - 20240314",
        "carType": "C1",
        "address": "广东省珠海市香洲区行",
        "name": "林*",
        "nationality": "中国",
        "birth": "",
        "sex": "女",
        "firstGetCard": "20180314"
    },
    "code": "200000"
}

• 查询失败示例

复制成功
{
    "code": "500000",
    "success": false,
    "message": "系统异常",
    "chargeStatus": 0
}

9、 银行卡文字识别

9.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/i/ocr/bankcard

9.2、请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://www.chuanglan.com/登录后获取
appKey	String	是	请在https://www.chuanglan.com/登录后获取
image	string	是	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp
imageType	String	是	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码

9.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
reqId	String	请求id
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
data	Object	返回对象
tradeNo	String	交易号，唯一。样例：18041109215057630
cardNum	String	银行卡账号
cardType	String	卡类型（0:未知银行; 1: 借记卡; 2: 信用卡; 3: 预付费卡）
code	String	银行卡检测业务返回码 0 成功，其他失败
msg	String	银行卡检测业务返回码对应说明
cardName	String	银行卡名称（建设银行、招商银行等）
validDate	String	有效期（格式：月/年）

9.4、响应示例

• • 查询成功示例：

复制成功
{
    "chargeStatus": 1,
    "message": "成功",
    "reqId": "iRPw1155886914683373568",
    "data": {
        "msg": "成功",
        "cardNum": "6217 0072 **** **** *87",
        "code": "0",
        "tradeNo": "18062915460891137",
        "cardName": "建设银行",
        "cardType": "1"
    },
    "code": "200000"
}

• 查询失败示例

复制成功
{
    "code": "500000",
    "success": false,
    "message": "系统异常",
    "chargeStatus": 0
}

10、 营业执照OCR

10.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/i/ocr/business-license

10.2、请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://www.chuanglan.com/登录后获取
appKey	String	是	请在https://www.chuanglan.com/登录后获取
image	string	是	识别图片，请确保内容信息清晰可见。支持url或base64，图片大小不能大于2M,支持图片类型：jpg/png/bmp
imageType	String	是	图片类型，枚举值：URL-图片路径 ,BASE64 –图片BASE64编码

10.3、响应参数说明

说明	类型	说明
code	String	响应 code 码。200000：成功，其他失败
message	String	响应 code 码解释
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
data	Object	返回对象
+msg	String	营业执照识别业务返回码对应说明
+number	String	编号
+code	String	营业执照识别业务返回码 0 成功，其他失败
+address	String	单位地址
+creditCode	String	社会信用代码
+tradeNo	String	交易号
+validDate	String	有效时间
+companyName	String	单位名称
+legalPerson	String	法人代表

10.4、响应示例

• • 查询成功示例：

复制成功
{
    "chargeStatus": "1",
    "message": "成功",
    "data": {
        "msg": "成功",
        "number": "无",
        "code": "0",
        "address": "上海市松江区中创路68号19幢型有限责任公司(自然人投资或控股)",
        "creditCode": "913101165727226313",
        "tradeNo": "18070410373933958",
        "validDate": "2021年04月18日",
        "companyName": "上海创蓝文化传播有限公司",
        "legalPerson": "唐小波"
    },
    "code": "200000"
}

• 查询失败示例

复制成功
{
    "code": "500000",
    "success": false,
    "message": "系统异常",
    "chargeStatus": 0
}