API Reference
中文

ID Verification Detailed Version -Indonesia

ID verification is used to verify the ID information in Indonesia.

API Method

Base URL

API

URLRequest MethodsContent-TypeOutput FormatCharacter Set
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8
Authentication
ParameterTypeDescriptionRequired/OptionalNotes
partner_codeStringPartner CodeRequiredAssigned by TD
partner_keyStringPartner KeyRequiredAssigned by TD

Request

ParameterTypeDescriptionRequired/OptionalNotes
id_numberStringID typeRequiredID number
id_typeStringID numberRequiredEnumeration: KTP
phone_numberStringPhone numberoptionalBeginning with 08, 10 to 13, example: 081234567890
nameStringNameRequired
countryStringCountryRequired2-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

ParameterTypeDescriptionRequired/OptionalNotes
codeIntegerAPI status codeRequired
messageStringStatus InformationRequiredApecific abnormal reasons will be provided when the API is abnormal
sequence_idStringUnique response codeRequiredA unique ID used to track each request
resultStringResultRequiredEnumeration:
1. success
2. fail
3. no record
further_infoStringmore infomation about userConditionally Required, when result=passsee table "further_info parameter" below
Further_info Parameter
ParameterTypeDescriptionExample
id_numberStringID number1101010107730074
nameStringnameASNAWI ADEN
birth_placeStringplace of birthBAKONGAN
birth_dateStringdate of birth1973-07-01 00:00:00
religionStringreligionISLAM
genderStringgenderMale
provinceStringprovince of household registrationACEH
cityStringcity of household registrationKAB. ACEH SELATAN
districtStringdistrict of household registrationBakongan
villageStringvillage of household registrationPadang Beurahan
office_typeStringcode of workplace0105

API Status Code

Code MessageDescriptionCharged
200successSuccessYES
301Service not purchasedService not purchasedNO
302Traffic blockedTraffic blockedNO
303Traffic insufficientTraffic insufficientNO
304Service expiredService expiredNO
305Daily maximum volume reachedDaily maximum volume reachedNO
600Service Temporarily UnavailableService reached limitNO
11350Internal errorInternal errorNO
11301{parameter} empty{parameter} emptyNO
11304The country partner located is not openThe country partner located is not openNO
11340{parameter} error{parameter} errorNO

Response Example

  • Success
{   
 "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
{
    "code":11340,
    "sequence_id":"170427842997****I3167369D6187177",
    "message":"phone_number error"
}