API Reference
中文

Indonesia Phone Number Detection

This product is used for Indonesian phone number association detection, which can help customers reach active users and re-engage dormant users.

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 numberRequiredID number
id_typeStringID typeRequiredIndonesia - enumeration value: KTP
phone_numberStringPhone numberRequiredExample: 081234567890, start with 08
emergency_contact_idStringEmergency contact ID numberStrongly recommendedEmergency contact ID number. If it is empty, no emergency contact result will be returned.
emergency_contact_phoneStringEmergency contact phone numberStrongly recommendedExample: 08123456789. If it is empty, the phone number related information in the emergency contact result will not be returned.
emergency_contact_nameStringEmergency contact nameStrongly recommended
nameStringNameStrongly recommended
countryStringCountryRequiredCountry, required. Two-digit country code, compliant with ISO 3166 standard. Currently supported: Indonesia (ID)

Request Example

{
    "country": "ID",
    "phone_number": "081234567890",
    "id_type": "KTP",
    "id_number": "3310225629467",
    "name": "Joe",
    "emergency_contact_id": "3310225629467",
    "emergency_contact_phone": "081234567890",
    "emergency_contact_name": "Joe"
}

Response Parameter

ParameterTypeDescriptionRequired/OptionalNotes
codeIntegerAPI status codeRequired
messageStringStatus InformationRequiredSpecific abnormal reasons will be provided when the API is abnormal
sequence_idStringUnique response codeRequiredA unique ID used to track each request
resultObjectVerification resultRequired
phone_number_countIntNumber of associated phone numbersRequired
applicator_resultObjectApplicator resultRequired
is_recently_usedStringWhether it is the most recently used mobile phone numberRequiredTrue: The most recently used
False: Not recently used
is_frequently_usedStringWhether it is the most commonly used mobile phone numberRequiredTrue: The most commonly used
False: Not the most commonly used
is_otherStringWhether it is another mobile phone numberRequiredTrue: Other uses
False: Not for other uses
emergency_contact_resultObjectEmergency contact resultsConditionally required
relation_with_applicatorStringRelationship with applicantConditionally requiredEnumeration value:
Spouse
Parents
Children
Grandparents
Grandchildren
Brothers&sisters
Others
Unknown
is_recently_usedStringWhether it is the most recently used mobile phone numberConditionally requiredTrue: Recently used
False: Not recently used
Unknown: There is no record in the library
is_frequently_usedStringWhether it is the most commonly used mobile phone numberConditionally requiredTrue: Most commonly used
False: Not the most commonly used
Unknown: There is no record in the library

API Status Code

Code MessageDescriptionCharged
200successSuccessYES
300Service not purchased or not effectiveService not purchased or not effectiveNO
301Service not purchasedService not purchasedNO
302Traffic blockedTraffic blockedNO
303Traffic insufficientTraffic insufficientNO
304Service expiredService expiredNO
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
12701No recordThere is no record in the libraryNO

Response Example

-When both the emergency contact ID and phone number are not empty
{
    "code": 200,
    "message": "",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "result": {
        "phone_number_count": 2,
        "applicator_result": {
            "is_recently_used": "True",
            "is_frequently_used": "False",
            "is_other": "False"
        },
        "emergency_contact_result": {
            "relation_with_applicator": "Spouse",
            "is_recently_used":"True",
            "is_frequently_used": "False",
            "is_other": "False"
        }
    }
}
-When the emergency contact ID is not empty and the phone number is empty
{
    "code": 200,
    "message": "",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "result": {
        "phone_number_count": 2,
        "applicator_result": {
            "is_recently_used": "True",
            "is_frequently_used": "False",
            "is_other": "False"
        },
        "emergency_contact_result": {
            "relation_with_applicator": "Spouse"
        }
    }
}
-When the emergency contact ID is empty and the phone number is not empty
{
    "code": 200,
    "message": "",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "result": {
        "phone_number_count": 2,
        "applicator_result": {
            "is_recently_used": "True",
            "is_frequently_used": "False",
            "is_other": "False"
        },
        "emergency_contact_result": {
            "relation_with_applicator": "Unknown",
            "is_recently_used":"Unknown",
            "is_frequently_used": "Unknown",
            "is_other": "Unknown"
        }
    }
}
-When the emergency contact ID and phone number are both empty
{
    "code": 200,
    "message": "",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "result": {
        "phone_number_count": 2,
        "applicator_result": {
            "is_recently_used": "True",
            "is_frequently_used": "False",
            "is_other": "False"
        }
    }
}