进件接口

接口描述

进件接口

请求路径

/v1/md5/apply/{appid}

请求方式

POST

请求参数

Header

参数名	参数值	必填	描述
Content-Type	application/json	Y	body传递json格式参数

Param

参数名	类型	必选	描述
appid	String	Y	联系运营人员

Body

下方数据加密后，放入 bizData 字段，详见API 通用说明;

参数名	类型	必选	描述
channelCode	string	Y	渠道商编码（我方提供，唯一标识渠道商）
os	integer	N	操作系统类型 取值：1=IOS，2=安卓；示例：2（安卓）
mobileNo	string	Y	手机号明文（复用字段，由撞库获取字段前筛）
name	string	N	真实姓名明文（复用字段，由撞库获取字段前筛）
idCard	string	N	身份证号
carNum	string	N	车牌号（格式如：京AXXXX）
provinceName	string	N	所属省份名称 示例："广东省"
city	string	N	所属城市名称（需与预定义城市json数据匹配）示例："深圳市"
clientIp	string	N	客户IP地址（IPv4格式）合法IPv4地址（如："192.168.1.100"）
age	integer	N	年龄数值 示例：28（18-60岁常见范围）
sex	integer	N	性别标识 取值：0=女，1=男；示例：1（男）
profession	integer	N	职业分类编码 取值：200=上班族，300=自由职业，400=企业主，500=个体户，800=公务员，900=其他；默认值：200
degree	integer	N	学历分类编码 取值：1=本科及以上，2=大专，3=中专，4=高中及以下；示例：2（大专）
house	integer	N	房产情况 取值：0=无房产，10=有房产不抵押，20=有房产可抵押；示例：10（有房产不抵押）
car	integer	N	车产情况（(0:无车,1:有且接受抵押,2:有且不接受抵押)）
carLoan	integer	N	车贷情况 取值：1=全款，2=贷款已结清，3=贷款未结清；示例：3（贷款未结清）
sbScop	integer	N	社保缴纳情况 取值：0=无社保，10=缴纳未满6个月，20=缴纳6个月以上；示例：20（缴纳6个月以上）
gjjScop	integer	N	公积金缴纳情况 取值：0=无公积金，10=缴纳未满6个月，20=缴纳6个月以上；示例：10（缴纳未满6个月）
baodanScop	integer	N	保单情况 取值：0=无保险保单，10=缴纳未满1年，20=缴纳1年以上；示例：20（缴纳1年以上）
creditCard	integer	N	信用卡持有情况 取值：0=无，10=有；示例：10（有信用卡）
huaBeiScop	integer	N	花呗额度 取值：0=无，1=0-5000，2=5000-10000，3=额度10000以上；示例：2（5000-10000）
baiTiaoScop	integer	N	白条额度 取值：0=无，1=0-2000，2=2000-5000，3=额度5000以上；示例：3（额度5000以上）
creditStatus	integer	N	征信情况 取值：0=无逾期，1=有逾期；示例：0（无逾期）
sesameScore	integer	N	芝麻分等级 取值：0=无芝麻分，10=600分以下，20=600650分，30=650700分，40=700分以上；示例：30（650~700分）
loanMoney	BigDecimal	N	借款金额（单位：万元）示例：5.5（代表5.5万元）
payoffType	integer	N	工资发放形式 取值：10=银行卡，20=现金，30=自存；默认值：10
outTradeNo	string	Y	撞库返回的序列号（需与我方系统记录一致）示例："20250811100200001"（唯一标识，必填）
returnUrl	string	N	用户返回地址（业务操作完成后跳转的目标页面URL）示例："https://example.com/return"
userAgent	string	N	用户终端UA（User-Agent，设备网络请求头信息）示例："Mozilla/5.0 (...Safari/604.1"
carBrand	String	N	汽车品牌，实例：捷途山海T2

请求示例

appid=111

{
    "channelCode": "",
    "os": 0,
    "mobileNo": "",
    "name": "",
    "idCard": "",
    "carNum": "",
    "provinceName": "",
    "city": "",
    "clientIp": "",
    "age": 0,
    "sex": 0,
    "profession": 0,
    "degree": 0,
    "house": 0,
    "car": 0,
    "carLoan": 0,
    "sbScop": 0,
    "gjjScop": 0,
    "baodanScop": 0,
    "creditCard": 0,
    "huaBeiScop": 0,
    "baiTiaoScop": 0,
    "creditStatus": 0,
    "sesameScore": 0,
    "loanMoney": null,
    "payoffType": 0,
    "outTradeNo": "",
    "returnUrl": "",
    "userAgent": "",
	"carBrand":"tesla model Y"
}

返回参数

参数名	类型	必选	描述
code	Integer	Y	200成功，不等于200都是失败
msg	String	N	失败原因
data	ApplyResultVo	N	返回数据

data字段说明

参数名	类型	必选	描述
outTradeNo	String	N	进件序列号

返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "outTradeNo": ""
    },
    "requestId": ""
}

Protocol Buffers 定义

以下是使用 protobuf 格式定义的请求和响应消息结构：

syntax = "proto3";

package api;

// 操作系统类型
enum OSType {
  OS_TYPE_UNKNOWN = 0;  // 未知
  OS_TYPE_IOS = 1;      // IOS
  OS_TYPE_ANDROID = 2;   // 安卓
}

// 性别类型
enum SexType {
  SEX_TYPE_FEMALE = 0;   // 女
  SEX_TYPE_MALE = 1;     // 男
}

// 职业分类
enum ProfessionType {
  PROFESSION_TYPE_UNKNOWN = 0;   // 未知
  PROFESSION_TYPE_EMPLOYEE = 200;  // 上班族
  PROFESSION_TYPE_FREELANCE = 300;  // 自由职业
  PROFESSION_TYPE_ENTERPRISE_OWNER = 400; // 企业主
  PROFESSION_TYPE_INDIVIDUAL = 500; // 个体户
  PROFESSION_TYPE_CIVIL_SERVANT = 800; // 公务员
  PROFESSION_TYPE_OTHER = 900;     // 其他
}

// 学历分类
enum DegreeType {
  DEGREE_TYPE_UNKNOWN = 0;       // 未知
  DEGREE_TYPE_BACHELOR_OR_ABOVE = 1;  // 本科及以上
  DEGREE_TYPE_JUNIOR_COLLEGE = 2;     // 大专
  DEGREE_TYPE_SECONDARY_SPECIALTY = 3; // 中专
  DEGREE_TYPE_HIGH_SCHOOL_OR_BELOW = 4; // 高中及以下
}

// 房产情况
enum HouseStatus {
  HOUSE_STATUS_NONE = 0;        // 无房产
  HOUSE_STATUS_NOT_MORTGAGED = 10; // 有房产不抵押
  HOUSE_STATUS_MORTGAGABLE = 20;   // 有房产可抵押
}

// 车产情况
enum CarStatus {
  CAR_STATUS_NONE = 0;        // 无车
  CAR_STATUS_MORTGAGE = 1;    // 有且接受抵押
  CAR_STATUS_NO_MORTGAGE = 2; // 有且不接受抵押
}

// 车贷情况
enum CarLoanStatus {
  CAR_LOAN_STATUS_UNKNOWN = 0; // 未知
  CAR_LOAN_STATUS_FULLY_PAID = 1; // 全款
  CAR_LOAN_STATUS_SETTLED = 2;    // 贷款已结清
  CAR_LOAN_STATUS_OUTSTANDING = 3; // 贷款未结清
}

// 社保缴纳情况
enum SocialSecurityScope {
  SOCIAL_SECURITY_NONE = 0;           // 无社保
  SOCIAL_SECURITY_LESS_6_MONTHS = 10;   // 缴纳未满6个月
  SOCIAL_SECURITY_OVER_6_MONTHS = 20;    // 缴纳6个月以上
}

// 公积金缴纳情况
enum HousingFundScope {
  HOUSING_FUND_NONE = 0;           // 无公积金
  HOUSING_FUND_LESS_6_MONTHS = 10;   // 缴纳未满6个月
  HOUSING_FUND_OVER_6_MONTHS = 20;    // 缴纳6个月以上
}

// 保单情况
enum InsuranceScope {
  INSURANCE_NONE = 0;          // 无保险保单
  INSURANCE_LESS_1_YEAR = 10;  // 缴纳未满1年
  INSURANCE_OVER_1_YEAR = 20;   // 缴纳1年以上
}

// 信用卡持有情况
enum CreditCardStatus {
  CREDIT_CARD_NONE = 0;  // 无
  CREDIT_CARD_HAS = 10;  // 有
}

// 花呗额度
enum HuabeiScope {
  HUABEI_NONE = 0;          // 无
  HUABEI_0_TO_5000 = 1;      // 0-5000
  HUABEI_5000_TO_10000 = 2;  // 5000-10000
  HUABEI_OVER_10000 = 3;     // 额度10000以上
}

// 白条额度
enum BaitiaoScope {
  BAITIAO_NONE = 0;       // 无
  BAITIAO_0_TO_2000 = 1;    // 0-2000
  BAITIAO_2000_TO_5000 = 2; // 2000-5000
  BAITIAO_OVER_5000 = 3;    // 额度5000以上
}

// 征信情况
enum CreditStatus {
  CREDIT_STATUS_NO_OVERDUE = 0; // 无逾期
  CREDIT_STATUS_HAS_OVERDUE = 1; // 有逾期
}

// 芝麻分等级
enum SesameScore {
  SESAME_SCORE_NONE = 0;         // 无芝麻分
  SESAME_SCORE_BELOW_600 = 10;     // 600分以下
  SESAME_SCORE_600_TO_650 = 20;    // 600-650分
  SESAME_SCORE_650_TO_700 = 30;    // 650-700分
  SESAME_SCORE_OVER_700 = 40;      // 700分以上
}

// 工资发放形式
enum PayoffType {
  PAYOFF_TYPE_UNKNOWN = 0; // 未知
  PAYOFF_TYPE_BANK_CARD = 10; // 银行卡
  PAYOFF_TYPE_CASH = 20;      // 现金
  PAYOFF_TYPE_SELF_DEPOSIT = 30; // 自存
}

// 进件请求
message ApplyRequest {
  string channelCode = 1;      // 渠道商编码 (必填)
  optional OSType os = 2;             // 操作系统类型 (可选)
  string mobileNo = 3;        // 手机号明文 (必填)
  optional string name = 4;           // 真实姓名明文 (可选)
  optional string idCard = 5;          // 身份证号 (可选)
  optional string carNum = 6;          // 车牌号 (可选)
  optional string provinceName = 7;     // 所属省份名称 (可选)
  optional string city = 8;            // 所属城市名称 (可选)
  optional string clientIp = 9;        // 客户IP地址 (可选)
  optional int32 age = 10;             // 年龄 (可选)
  optional SexType sex = 11;           // 性别标识 (可选)
  optional ProfessionType profession = 12;  // 职业分类编码 (可选)
  optional DegreeType degree = 13;      // 学历分类编码 (可选)
  optional HouseStatus house = 14;     // 房产情况 (可选)
  optional CarStatus car = 15;         // 车产情况 (可选)
  optional CarLoanStatus carLoan = 16; // 车贷情况 (可选)
  optional SocialSecurityScope sbScop = 17;     // 社保缴纳情况 (可选)
  optional HousingFundScope gjjScop = 18;       // 公积金缴纳情况 (可选)
  optional InsuranceScope baodanScop = 19;      // 保单情况 (可选)
  optional CreditCardStatus creditCard = 20;     // 信用卡持有情况 (可选)
  optional HuabeiScope huaBeiScop = 21;          // 花呗额度 (可选)
  optional BaitiaoScope baiTiaoScop = 22;       // 白条额度 (可选)
  optional CreditStatus creditStatus = 23;       // 征信情况 (可选)
  optional SesameScore sesameScore = 24;          // 芝麻分等级 (可选)
  optional double loanMoney = 25;       // 借款金额（单位：万元）(可选)
  optional PayoffType payoffType = 26;  // 工资发放形式 (可选)
  string outTradeNo = 27;      // 撞库返回的序列号 (必填)
  optional string returnUrl = 28;       // 用户返回地址 (可选)
  optional string userAgent = 29;       // 用户终端UA (可选)
  optional string carBrand = 30;        // 汽车品牌 (可选)
}

// 进件结果
message ApplyResultVo {
  optional string outTradeNo = 1; // 进件序列号
}

// 进件响应
message ApplyResponse {
  int32 code = 1;          // 200成功，不等于200都是失败
  optional string msg = 2;          // 失败原因
  optional ApplyResultVo data = 3;  // 返回数据
  string requestId = 4;    // traceId
}

使用方可以通过以上 proto 定义快速生成相应的代码结构和类型定义。