ID Verification API Integration Guide
Overview
ID verification is used to verify the ID information in Indonesia.
API Method
Base URL
- Indonesia: ID Verification Endpoint
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 | Notes |
|---|---|---|---|---|
| partner_code | String | Partner Code | Required | Assigned by TD |
| partner_key | String | Partner Key | Required | Assigned by TD |
Request Parameters
| Parameter | Type | Description | Required | Notes |
|---|---|---|---|---|
| id_number | String | ID number | Required | ID number |
| id_type | String | ID type | Required | Enumeration: KTP |
| phone_number | String | Phone number | Required | Beginning with 08, 10 to 13 characters, e.g., 081234567890 |
| name | String | Name | Required | - |
| country | String | Country | Required | 2-letter country code (ISO 3166) Support: ID (Indonesia) |
Request Example
{
"country": "ID",
"phone_number": "081234567890",
"id_type": "KTP",
"id_number": "3310225629467",
"name": "Joe"
}Response Parameters
| Parameter | Type | Description | Required | Notes |
|---|---|---|---|---|
| code | Integer | API status code | Required | - |
| message | String | Status information | Required | Specific reasons provided for abnormal responses |
| sequence_id | String | Unique response code | Required | Tracks each request |
| result | String | Verification result | Required | Enumeration: success, fail |
| id_phone_match | String | ID number and mobile phone match | Required | Enumeration: pass, fail, no_record_for_phone_number |
| id_name_match | String | ID number and name match | Required | Enumeration: pass, fail, no_record_for_id_number |
API Status Codes
| 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 |
Response Examples
Success (Verification Passed)
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": "pass",
"id_phone_match": "pass",
"id_name_match": "pass"
}Success (Verification Failed)
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": "fail",
"id_phone_match": "pass",
"id_name_match": "fail"
}Failure Response
{
"code": 11340,
"sequence_id": "170427842997****I3167369D6187177",
"message": "phone_number error"
}