ID verification is used to verify the ID information in Indonesia.
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 type | Required | ID number |
id_type | String | ID number | Required | Enumeration: KTP |
phone_number | String | Phone number | Required | Beginning with 08, 10 to 13, example: 081234567890 |
name | String | Name | Required | |
country | String | Country | Required | 2-letter country code according to ISO 3166 Support: ID(Indonesia) |
Request Example
{
"country":"ID",
"phone_number":"081234567890",
"id_type":"KTP",
"id_number":"3310225629467",
"name":"Joe"
}
Response Parameter
Parameter | Type | Description | Required/Optional | Notes |
---|---|---|---|---|
code | Integer | API status code | Required | |
message | String | Status Information | Required | Apecific abnormal reasons will be provided when the API is abnormal |
sequence_id | String | Unique response code | Required | A unique ID used to track each request |
result | String | Result | Required | Enumeration: 1. success 2. fail |
id_phone_match | String | Whether the ID number and mobile phone number match | Required | Enumeration: 1. pass 2. fail 3.no_record_for_phone_number |
id_name_match | String | Whether the ID number and name match | Required | Enumeration: 1. pass 2. fail 3. no_record_for_id_number |
API Status Code
Code | Message | Description | Charged |
---|---|---|---|
200 | success | Success | YES |
301 | Service not purchased | Service not purchased | NO |
302 | Traffic blocked | Traffic blocked | NO |
303 | Traffic insufficient | Traffic insufficient | NO |
304 | Service expired | Service expired | NO |
305 | Daily maximum volume reached | Daily maximum volume reached | NO |
600 | Service Temporarily Unavailable | Service reached limit | NO |
11350 | Internal error | Internal error | NO |
11301 | {parameter} empty | {parameter} empty | NO |
11304 | The country partner located is not open | The country partner located is not open | NO |
11340 | {parameter} error | {parameter} error | NO |
Response Example
- Success(result=pass)
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": "pass",
"id_phone_match": "pass",
"id_name_match": "pass"
}
- Success(result=fail)
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": "fail",
"id_phone_match": "pass",
"id_name_match": "fail"
}
- Failure
{
"code":11340,
"sequence_id":"170427842997****I3167369D6187177",
"message":"phone_number error"
}