This interface can be used to query blacklist information in many countries, such as Indonesia and Mexico. And this API is realtime. Data will be return immediately based on input parameter value.
API Method
Base URL
- Indonesia: Credit Data List Endpoint
- Singapore: Credit Data List Endpoint
API
| Request Methods | Content-Type | Output Format | Character Set |
|---|---|---|---|
| POST | application/json | Json | UTF-8 |
Authentication
| Parameter | Type | Required/Optional | Notes |
|---|---|---|---|
| partner_code | String | Required | To be assigned by TD |
| partner_key | String | Required | To be assigned by TD |
Request Parameter
| Parameter | Type | Required/Optional | Notes |
|---|---|---|---|
| name | String | Required | Name |
| phone_number | String | Required | Mobile phone number, no country code |
| id_number | String | Required | ID card number. For example: - Indonesia: 16 digits pure numbers - Mexico: 18 digits |
| country | String | Required | Supported countries: - Mexico (MX) - Indonesia (ID) - India (IN) - Thailand (TH) - Colombia (CO) - Philippines (PH) - Nigeria (NG) - Pakistan (PK) - Vietnam (VN) |
| id_type | String | Required | Enumerated value: national_id Philippine ID types include: - UMID - SSS card - Passport - Driver's license - PRC ID - Postal ID - PhilHealth - AFP ID - HDMF ID - ACR/ICR - GSIS card - TIN - Seaman's book - OWWA ID - Voter's ID |
| package_name | String | Required | Enumerated value: blacklist |
Response Parameter
| Parameter | Type | Description | Notes |
|---|---|---|---|
| code | Integer | API status code | |
| message | String | Status information | The specific cause of the exception is displayed when the API is in an abnormal state |
| sequence_id | String | Response unique code | A unique identifier used to track the record of each request |
| result | String | Hit or not | Enumerated values: hit\ no_record |
API Status Code
| code | Message | Description |
|---|---|---|
| 200 | Success, no message is returned | |
| 301 | This service has not been purchased | Service not purchased |
| 302 | The traffic has been disabled | Service has been suspend |
| 303 | Underflow | Not enough balance |
| 304 | Service expired | Service expired |
| 305 | The daily traffic has been capped | The daily traffic has been capped |
| 9060 | {parameter} empty | {parameter} empty |
| 9061 | {parameter} error | {parameter} error |
Hit Request Example
{
"code": 200,
"result": "hit",
"sequence_id": "1699272744735016I303341798930550"
}Non-hit Request Example
{
"code": 200,
"result": "no_record",
"sequence_id": "75ccadf47dab4c81a06e6f0da746cd9c"
}Failed Example
{
"code": 9060,
"message": " country empty"
}