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. KTP |
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: Indonesia (ID) |
name | String | Name | Required | |
phone_number | String | Phone number | Required | Indonesia only supports 10-13 pure numbers and + sign. Plain text only supports the following as the beginning: + 628, 628, 8, 08 |
app_name | String | App name | Strongly recommended | This field is strongly recommended for the selected packages exclude the following: behavior_analysis_of_repayment; multiplatform_multi_V1_1; multiplatform_V2; multiplatform_V2_m2 ; fraud_insight_graph_V1 |
package_name | String | Package name | Required | Enumeration value: Indonesia region: multiplatform_phone: multiplatform(phone) multiplatform_id: multiplatform(id) device_risk_detection: device history risk detection financial_assessment_level:economic capability assessment level credit_rating_estimation: Credit Rating Prediction behavior_analysis_of_repayment :behavior analysis of repayment multiplatform_multi_V1_1:Multiplatform V1.1 multiplatform_V2: multiplatfrom(phone number、id、GAID) V2 multiplatform_V2_m2: multiplatfrom(phone number、id、GAID) V2.1 fraud_insight_graph_V1: fraud insight graph V1 fraud_insight_graph_V2: fraud insight graph V2 Only one can be filled . |
device_id | String | Device ID | Conditionally required | This field is required if the equipment historical risk detection product is called and strongly recommended for fraud_insight_graph_V1 and fraud_insight_graph_V2 |
gaid | String | GAID | Conditionally required | This field is required if the multiplatform_V2, fraud_insight_graph_V1, multiplatform_V2_m2 and fraud_insight_graph_V2 products are selected i.e. cc15aaf9-01cf-4900-9a45-6f5643b00e2f |
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 | ||
id_number | JSONObject | Conditionally required | ID number dimension | Returned when select the following packages: multiplatform_V2: multiplatfrom(phone number、id、GAID) V2; multiplatform_V2_m2: multiplatfrom(phone number、id、GAID) V2.1 fraud_insight_graph_V2: fraud insight graph V2 |
phone_number | JSONObject | Conditionally required | Phone number dimension | Returned when select the following packages: multiplatform_V2: multiplatfrom(phone number、id、GAID) V2; multiplatform_V2_m2: multiplatfrom(phone number、id、GAID) V2.1 fraud_insight_graph_V2: fraud insight graph V2 |
gaid | JSONObject | Conditionally required | GAID dimension | Returned when select the following packages: multiplatform_V2: multiplatfrom(phone number、id、GAID) V2; multiplatform_V2_m2: multiplatfrom(phone number、id、GAID) V2.1 fraud_insight_graph_V2: fraud insight graph V2 |
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 -888: Internal Error, please contact our operation team Remark: the type of parameter will be different according to different indicators |
indicator_status | Int | Conditionally required exclude multiplatform_V2 and fraud_insight_graph_V1 | 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
}
]
}
Response Example-multiplatform_V2
{
"code": 200,
"sequence_id": "53b63090c0374cad82********f8991e",
"data": {
"id_number": [
{
"indicator_name": "indicator_name_1",
"indicator_value": 1
},
{
"indicator_name": "indicator_name_2",
"indicator_value": 2
}
],
"phone_number": [
{
"indicator_name": "indicator_name_1",
"indicator_value": 1
},
{
"indicator_name": "indicator_name_2",
"indicator_value": 4
}
],
"gaid": [
{
"indicator_name": "indicator_name_1",
"indicator_value": 1
},
{
"indicator_name": "indicator_name_2",
"indicator_value": 8
}
]
}
}
}
Failed Example
{
"code": 9061,
"sequence_id": "80b57561b6fb********61ccba263b60",
"message": "country error"
}