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 | Enumeration value: National ID card (national_id) |
country | String | Country | Required | Two-digit country code (ISO 3166) Supported: Indonesia (ID) |
name | String | Name | Required | - |
phone_number | String | Phone number | Required | Indonesia supports 10-13 pure numbers Accepted prefixes: +628, 628, 8, 08 |
app_name | String | App name | Strongly recommended | Not required for specific packages: - behavior_analysis_of_repayment - multiplatform_multi_V1_1 - multiplatform_V2 - multiplatform_V2_m2 - fraud_insight_graph_V1 |
package_name | String | Package name | Required | Indonesia region packages: - multiplatform_phone - multiplatform_id - device_risk_detection - financial_assessment_level - credit_rating_estimation - behavior_analysis_of_repayment - multiplatform_multi_V1_1 - multiplatform_V2 - multiplatform_V2_m2 - fraud_insight_graph_V1 - fraud_insight_graph_V2 Only one package can be selected |
device_id | String | Device ID | Conditionally required | Required for equipment historical risk detection Strongly recommended for fraud_insight_graph_V1 and V2 |
gaid | String | GAID | Conditionally required | Required for: - multiplatform_V2 - fraud_insight_graph_V1 - multiplatform_V2_m2 - fraud_insight_graph_V2 Example: cc15aaf9-01cf-4900-9a45-6f5643b00e2f |
Response Parameter
Parameter | Type | Required/Optional | Description | Notes |
---|---|---|---|---|
code | Integer | Required | API status code | - |
message | String | Required | Status information | In API exception state, specific exception reason will be output |
sequence_id | String | Required | Response unique code | Unique identifier to track each request record |
data | Array | Required | Response data | - |
id_number | JSONObject | Conditionally required | ID number dimension | Returned for packages: - multiplatform_V2 - multiplatform_V2_m2 - fraud_insight_graph_V2 |
phone_number | JSONObject | Conditionally required | Phone number dimension | Returned for packages: - multiplatform_V2 - multiplatform_V2_m2 - fraud_insight_graph_V2 |
gaid | JSONObject | Conditionally required | GAID dimension | Returned for packages: - multiplatform_V2 - multiplatform_V2_m2 - fraud_insight_graph_V2 |
indicator_name | String | Required | Indicator name | - |
indicator_value | String/Int | Required | Indicator value | Special values: - -1111: Unable to calculate - -999: No record in library - -888: Internal Error |
indicator_status | Int | Conditionally required | Indicator status | Enumeration values: - 200: Success - 201: No record in library - 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"
}