API Method
Base URL
API
| URL | Request Methods | Content-Type | Output Format | Character Set |
|---|---|---|---|---|
| api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
Authentication
| Parameter | Type | Description | Required/Optional | Notes |
|---|---|---|---|---|
| partner_code | String | Partner Code | Required | assigned by TD |
| partner_key | String | Partner Key | Required | assigned by TD |
Request
| Parameter | Type | Description | Required/Optional | Notes |
|---|---|---|---|---|
| id_number | String | ID number | Required | ID number，i.e. CURP for Mexico |
| id_type | String | ID type | Required | ID type enumeration value: National ID card: national_id |
| country | String | Country | Required | Two-digit country code, compliant with ISO 3166 standard. Supported countries: Mexico (MX), India (IN), Thailand (TH), Colombia (CO), Philippines(PH), Vietnam (VN), Nigeria (NG), Pakistan (PK) |
| name | String | Name | Required | |
| phone_number | String | Phone number | Required | India/Mexico/Thailand: without country code, 10 digits in total; Philippines: without country code, a total of 11 digits Nigeria, Vietnam, Thailand, Pakistan: without country code, starting with 0 |
| app_name | String | App name | Strongly recommended | This field is strongly recommended if the packages exclude behavior_analysis_of_repayment and multiplatform_multi_V1_1 are selected. |
| package_name | String | Package name | Required | Enumeration value: Mexico, India, Thailand, Colombia,Philippines: credit_rating_estimation: Credit Rating Prediction multiplatform_multi:Multiplatform V1.0 behavior_analysis_of_repayment :behavior analysis of repayment multiplatform_multi_V1_1:Multiplatform V1.1 Vietnam, Nigeria, Pakistan: behavior_analysis_of_repayment :behavior analysis of repayment multiplatform_multi_V1_1:Multiplatform V1.1 Only one can be filled . |
Response Parameter
| Parameter | Type | Required/Optional | Description | Required/Optional |
|---|---|---|---|---|
| code | Integer | Required | API status code | |
| message | String | Required | Status information | In the API exception state, the specific exception reason will be output. |
| sequence_id | String | Required | Response unique code | Unique identifier used to track each request record |
| data | Array | Required | ||
| indicator_name | String | Required | Indicator name | |
| indicator_value | String/int | Required | Indicator value | The meaning of the special value of the indicator: -1111: Unable to calculate -999: No record in the library Remark: the type of parameter will be different according to different indicators |
| indicator_status | Int | Required | Indicator status | Enumeration value: 200: Success 201: No record in the library (no record of mobile phone number and ID number) 202: Indicator cannot be calculated 500: System error |
API Interface Response Code
| Code | Message | Description |
|---|---|---|
| 200 | Success | |
| 300 | Service not purchased or not effective | Service not purchased or not effective |
| 301 | Service not purchased | Service not purchased |
| 302 | Service has been suspend | Service has been suspend |
| 303 | Not enough balance | Not enought blance |
| 304 | Service expired | Service expired |
| 9500 | Internal error | Internal error |
| 9060 | {parameter} empty | {parameter} empty |
| 9061 | {parameter} error | {parameter} error |
| 9055 | The country partner located has no service | There is no service in your country/region |
| 9081 | The format of the phone number does not match with the country | The format of the phone number does not match with the country |
Response Example
{
"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
}
]
}
Failed Example
{
"code": 9061,
"sequence_id": "80b57561b6fb********61ccba263b60",
"message": "country error"
}