API Reference
English

信用指标-新加坡

API 方式

Base URL

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

认证参数

字段类型含义建议备注
partner_codeString合作方标识必须由 TD 分配
partner_keyString合作方密钥必须由 TD 分配

请求参数

字段类型含义建议备注
id_numberString身份证件 ID 号码必须ID number ,如墨西哥CURP
id_typeString身份证件 ID 类型必须ID 类型枚举值:
国民身份证:national_id
countryString国家必须两位国家码,符合 ISO 3166 标准。
支持国家:墨西哥(MX), 印度(IN), 泰国(TH),哥伦比亚(CO), 菲律宾(PH), 越南(VN), 尼日利亚(NG), 巴基斯坦(PK)
nameString姓名必须
phone_numberString手机号码必须印度/墨西哥/泰国:不带国家码,共 10位数字;
菲律宾:不带国家码, 共11位的数字
尼日利亚、越南、泰国、 巴基斯坦:不带国家码,以 0 开头
app_nameStringapp名称强烈建议选择 behavior_analysis_of_repayment 还款行为分析, multiplatform_multi_V1.1 多头1.1版本产品包时建议填入。
package_nameString产品名必须枚举值:
墨西哥, 印度, 泰国, 哥伦比亚,菲律宾地区:
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 还款行为分析
不可多传,只能传入一个。

响应参数

字段类型建议含义备注
codeInteger必须API 状态码
messageString必须状态信息在 API 异常状态下会输出具体的异常原因
sequence_idString必须响应唯一码用于跟踪每次请求记录的唯一标识
dataArray必须
indicator_nameString必须指标名
indicator_valueString/int必须指标值指标特殊值含义:
-1111:无法计算
-999:库无记录
注:返回类型根据不同指标(名)而不同
indicator_statusInt必须指标状态枚举值:
200:成功
201:库无记录(手机号、身份证号无记录)
202:指标无法计算
500:系统错误

API接口响应码

CodeMessage描述
200成功
300Service not purchased or not effective服务不可⽤
301Service not purchased服务未购买
302Service has been suspend服务已被禁⽤
303Not enough balance流量不足
304Service expired服务已过期
9500Internal error内部错误
9060{parameter} empty{字段名}为空
9061{parameter} error{字段名}错误
9055The country partner located has no service您所在的国家/地区没有服务
9081The 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"
}