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 码解释
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-身份证模糊，not_complete-身份证不完整，over_dark-欠曝，over_exposure-过曝，unknown-未知状态
direction	String	图像方向 -1-未定义，0-正向，1-逆时针 90 度，2-逆时针 180 度，3-逆时针 270 度

2、 行驶证文字识别V2

2.1、协议说明

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

2.2、请求参数

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

2.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
}

3、 驾驶证文字识别V2

3.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	[https://wsapi.253.com/open/ocr/driving-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	认证结果 正页
++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
}

4、 车牌文字识别OCR

4.1、协议说明

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

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	返回对象
+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
}