ID verification is used to verify the ID information in Indonesia.
| URL | Request Methods | Content-Type | Output Format | Character Set |
|---|
| api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
| Parameter | Type | Description | Required | Notes |
|---|
| partner_code | String | Partner Code | Required | Assigned by TD |
| partner_key | String | Partner Key | Required | Assigned by TD |
| Parameter | Type | Description | Required | Notes |
|---|
| id_number | String | ID number | Required | Unique identifier |
| id_type | String | ID type | Required | Enumeration: KTP |
| phone_number | String | Phone number | Optional | Beginning with 08, 10 to 13 characters |
| name | String | Name | Required | Full name |
| country | String | Country | Required | 2-letter country code (ISO 3166) Support: ID (Indonesia) |
{
"country": "ID",
"phone_number": "081234567890",
"id_type": "KTP",
"id_number": "3310225629467",
"name": "Joe"
}
| Parameter | Type | Description | Required | Notes |
|---|
| code | Integer | API status code | Required | - |
| message | String | Status information | Required | Specific reasons for abnormal responses |
| sequence_id | String | Unique response code | Required | Tracks each request |
| result | String | Verification result | Required | Enumeration: success, fail, no record |
| further_info | String | Additional user information | Conditional | Provided when result is pass |
| Parameter | Type | Description | Example |
|---|
| id_number | String | ID number | 1101010107730074 |
| name | String | Full name | ASNAWI ADEN |
| birth_place | String | Place of birth | BAKONGAN |
| birth_date | String | Date of birth | 1973-07-01 00:00:00 |
| religion | String | Religion | ISLAM |
| gender | String | Gender | Male |
| province | String | Province | ACEH |
| city | String | City | KAB. ACEH SELATAN |
| district | String | District | Bakongan |
| village | String | Village | Padang Beurahan |
| office_type | String | Workplace code | 0105 |
| Code | Message | Description | Charged |
|---|
| 200 | Success | Successful verification | YES |
| 301 | Service not purchased | Service unavailable | NO |
| 302 | Traffic blocked | Traffic blocked | NO |
| 303 | Traffic insufficient | Insufficient traffic | NO |
| 304 | Service expired | Service expired | NO |
| 305 | Daily maximum volume reached | Quota exceeded | NO |
| 600 | Service Temporarily Unavailable | Service limit reached | NO |
| 11350 | Internal error | Internal system error | NO |
| 11301 | {parameter} empty | Missing required parameter | NO |
| 11304 | Country partner not open | Partner not available | NO |
| 11340 | {parameter} error | Parameter validation failed | NO |
Success Response
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": "pass",
"further_info": {
"id_number": "1101010107730074",
"name": "ASNAWI ADEN",
"birth_place": "BAKONGAN",
"birth_date": "1973-07-01 00:00:00",
"religion": "ISLAM",
"gender": "Male",
"province": "ACEH",
"city": "KAB. ACEH SELATAN",
"district": "Bakongan",
"village": "Padang Beurahan",
"office_type": "0105"
}
}
Failure Response
{
"code": 11340,
"sequence_id": "170427842997****I3167369D6187177",
"message": "phone_number error"
}