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

Indonesia: https://id.apitd.net/verification/kyc/phonedetection/v1

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/Optional	Notes
partner_code	String	Partner Code	Required	Assigned by TD
partner_key	String	Partner Key	Required	Assigned by TD

Request

Parameter	Type	Description	Required/Optional	Notes
id_number	String	ID number	Required	ID number
id_type	String	ID type	Required	Indonesia - enumeration value: KTP
phone_number	String	Phone number	Required	Example: 081234567890, start with 08
emergency_contact_id	String	Emergency contact ID number	Strongly recommended	Emergency contact ID number. If it is empty, no emergency contact result will be returned.
emergency_contact_phone	String	Emergency contact phone number	Strongly recommended	Example: 08123456789. If it is empty, the phone number related information in the emergency contact result will not be returned.
emergency_contact_name	String	Emergency contact name	Strongly recommended
name	String	Name	Strongly recommended
country	String	Country	Required	Country, 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

Parameter	Type	Description	Required/Optional	Notes
code	Integer	API status code	Required
message	String	Status Information	Required	Specific abnormal reasons will be provided when the API is abnormal
sequence_id	String	Unique response code	Required	A unique ID used to track each request
result	Object	Verification result	Required
phone_number_count	Int	Number of associated phone numbers	Required
applicator_result	Object	Applicator result	Required
is_recently_used	String	Whether it is the most recently used mobile phone number	Required	True: The most recently used False: Not recently used
is_frequently_used	String	Whether it is the most commonly used mobile phone number	Required	True: The most commonly used False: Not the most commonly used
is_other	String	Whether it is another mobile phone number	Required	True: Other uses False: Not for other uses
emergency_contact_result	Object	Emergency contact results	Conditionally required
relation_with_applicator	String	Relationship with applicant	Conditionally required	Enumeration value： Spouse Parents Children Grandparents Grandchildren Brothers&sisters Others Unknown
is_recently_used	String	Whether it is the most recently used mobile phone number	Conditionally required	True: Recently used False: Not recently used Unknown: There is no record in the library
is_frequently_used	String	Whether it is the most commonly used mobile phone number	Conditionally required	True: Most commonly used False: Not the most commonly used Unknown: There is no record in the library

API Status Code

Code	Message	Description	Charged
200	success	Success	YES
300	Service not purchased or not effective	Service not purchased or not effective	NO
301	Service not purchased	Service not purchased	NO
302	Traffic blocked	Traffic blocked	NO
303	Traffic insufficient	Traffic insufficient	NO
304	Service expired	Service expired	NO
11350	Internal error	Internal error	NO
11301	{parameter} empty	{parameter} empty	NO
11304	The country partner located is not open	The country partner located is not open	NO
11340	{parameter} error	{parameter} error	NO
12701	No record	There is no record in the library	NO

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