API Reference
中文

ID Verification Detailed Version -Indonesia

ID Verification API Integration Guide

Overview

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
ParameterTypeDescriptionRequiredNotes
partner_codeStringPartner CodeRequiredAssigned by TD
partner_keyStringPartner KeyRequiredAssigned by TD

Request Parameters

ParameterTypeDescriptionRequiredNotes
id_numberStringID numberRequiredUnique identifier
id_typeStringID typeRequiredEnumeration: KTP
phone_numberStringPhone numberOptionalBeginning with 08, 10 to 13 characters
nameStringNameRequiredFull name
countryStringCountryRequired2-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

ParameterTypeDescriptionRequiredNotes
codeIntegerAPI status codeRequired-
messageStringStatus informationRequiredSpecific reasons for abnormal responses
sequence_idStringUnique response codeRequiredTracks each request
resultStringVerification resultRequiredEnumeration: success, fail, no record
further_infoStringAdditional user informationConditionalProvided when result is pass
Further Info Parameters
ParameterTypeDescriptionExample
id_numberStringID number1101010107730074
nameStringFull nameASNAWI ADEN
birth_placeStringPlace of birthBAKONGAN
birth_dateStringDate of birth1973-07-01 00:00:00
religionStringReligionISLAM
genderStringGenderMale
provinceStringProvinceACEH
cityStringCityKAB. ACEH SELATAN
districtStringDistrictBakongan
villageStringVillagePadang Beurahan
office_typeStringWorkplace code0105

API Status Codes

CodeMessageDescriptionCharged
200SuccessSuccessful verificationYES
301Service not purchasedService unavailableNO
302Traffic blockedTraffic blockedNO
303Traffic insufficientInsufficient trafficNO
304Service expiredService expiredNO
305Daily maximum volume reachedQuota exceededNO
600Service Temporarily UnavailableService limit reachedNO
11350Internal errorInternal system errorNO
11301{parameter} emptyMissing required parameterNO
11304Country partner not openPartner not availableNO
11340{parameter} errorParameter validation failedNO

Response Examples

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"
}