API Reference
中文

ID Verification -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 numberRequiredID number
id_typeStringID typeRequiredEnumeration: KTP
phone_numberStringPhone numberRequiredBeginning with 08, 10 to 13 characters, e.g., 081234567890
nameStringNameRequired-
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 provided for abnormal responses
sequence_idStringUnique response codeRequiredTracks each request
resultStringVerification resultRequiredEnumeration: success, fail
id_phone_matchStringID number and mobile phone matchRequiredEnumeration: pass, fail, no_record_for_phone_number
id_name_matchStringID number and name matchRequiredEnumeration: pass, fail, no_record_for_id_number

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
11301parameter emptyMissing required parameterNO
11304Country partner not openPartner not availableNO
11340parameter errorParameter validation failedNO

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