API 方式
Base URL
API
URL | 请求方式 | Content-Type | 输出格式 | 字符集 |
---|---|---|---|---|
api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
认证参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
partner_code | String | 合作方标识 | 必须 | 由 TD 分配 |
partner_key | String | 合作方密钥 | 必须 | 由 TD 分配 |
请求参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
id_number | String | 身份证件 ID 号码 | 必须 | ID number ,如墨西哥CURP |
id_type | String | 身份证件 ID 类型 | 必须 | ID 类型枚举值: 国民身份证:national_id |
country | String | 国家 | 必须 | 两位国家码,符合 ISO 3166 标准。 支持国家:墨西哥(MX), 印度(IN), 泰国(TH),哥伦比亚(CO), 菲律宾(PH), 越南(VN), 尼日利亚(NG), 巴基斯坦(PK) |
name | String | 姓名 | 必须 | |
phone_number | String | 手机号码 | 必须 | 印度/墨西哥/泰国:不带国家码,共 10位数字; 菲律宾:不带国家码, 共11位的数字 尼日利亚、越南、泰国、 巴基斯坦:不带国家码,以 0 开头 |
app_name | String | app名称 | 强烈建议 | 选择 非behavior_analysis_of_repayment 还款行为分析, multiplatform_multi_V1.1 多头1.1版本产品包时建议填入。 |
package_name | String | 产品名 | 必须 | 枚举值: 墨西哥, 印度, 泰国, 哥伦比亚,菲律宾地区: credit_rating_estimation 信用等级预测 multiplatform_multi 多头V1.0 behavior_analysis_of_repayment 还款行为分析 multiplatform_multi_V1_1 多头1.1版本 越南、尼日利亚、巴基斯坦地区: multiplatform_multi_V1_1 多头1.1版本 behavior_analysis_of_repayment 还款行为分析 不可多传,只能传入一个。 |
响应参数
字段 | 类型 | 建议 | 含义 | 备注 |
---|---|---|---|---|
code | Integer | 必须 | API 状态码 | |
message | String | 必须 | 状态信息 | 在 API 异常状态下会输出具体的异常原因 |
sequence_id | String | 必须 | 响应唯一码 | 用于跟踪每次请求记录的唯一标识 |
data | Array | 必须 | ||
indicator_name | String | 必须 | 指标名 | |
indicator_value | String/int | 必须 | 指标值 | 指标特殊值含义: -1111:无法计算 -999:库无记录 注:返回类型根据不同指标(名)而不同 |
indicator_status | Int | 必须 | 指标状态 | 枚举值: 200:成功 201:库无记录(手机号、身份证号无记录) 202:指标无法计算 500:系统错误 |
API接口响应码
Code | Message | 描述 |
---|---|---|
200 | 成功 | |
300 | Service not purchased or not effective | 服务不可⽤ |
301 | Service not purchased | 服务未购买 |
302 | Service has been suspend | 服务已被禁⽤ |
303 | Not enough balance | 流量不足 |
304 | Service expired | 服务已过期 |
9500 | Internal error | 内部错误 |
9060 | {parameter} empty | {字段名}为空 |
9061 | {parameter} error | {字段名}错误 |
9055 | The country partner located has no service | 您所在的国家/地区没有服务 |
9081 | The format of the phone number does not match with the country | 手机号所在国家非传入国家 |
响应样例
{
"code":200,
"sequence_id":"53b63090c0374cad82********f8991e",
"data":[
{
"indicator_name":"indicator_name_1",
"indicator_status":200,
"indicator_value":1
},
{
"indicator_name":"indicator_name_2",
"indicator_status":200,
"indicator_value":1
}
]
}
失败样例
{
"code": 9061,
"sequence_id": "80b57561b6fb********61ccba263b60",
"message": "country error"
}