Indonesia Family Insights

This product is applicable to the verification of Indonesian family information.

API Method

Base URL

Indonesia: https://id-credit.apitd.net/verification/kyc/familyinsights/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
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"
}

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	Result	Required
personal_info	Object	Personal Information	Required
family_type	String	Family Type	Required	KEPALA KELUARGA
id_number	String	ID number	Required	3526074107710317
kk	String	kk	Required
birth_place	String	Place of Birth	Required	JAKARTA
name	String	Name	Required	NEMMOH
birth_date	String	Date of Birth	Required	1973-07-01 00:00:00
religion	String	Religion	Required	ISLAM
gender	String	Gender	Required	Enumeration value： Male Female
person_device_count_12months	Int	Total number of personal devices in the past 12 months (deduplication)	Required	The meaning of the special value of the indicator: -999: No record in the library -888: Internal Error, please contact our operation team
family_basic_info	Object	Family Basic Information	Required
family_member_count	Int	Number of Family Members	Required
family_child_count	Int	Number of minor children (under 18 years old)	Required
family_elder_count	Int	Number of people aged 60 and above	Required
family_gaji_count	int	Number of people with wage income	Required
family_permi_count	int	Number of people paying insurance premiums	Required
family_device_count_12months	Int	Total number of household devices in the past 12 months (deduplication)	Required	The meaning of the special value of the indicator: -999: No record in the library -888: Internal Error, please contact our operation team
total_income_12months	String	Total annual household revenue	Required	See the data dictionary of ”total_revenue_12months“
avg_income_12months	String	Average annual household revenue	Required	See the data dictionary of ”avg_revenue_12months“
query_info	Object	Query Information	Required
family_query_times_1/2/3/6/12months	Int	The total number of inquiries of all family members in our company in the past [1/2/3/6/12]months	Required	The meaning of the special value of the indicator: -999: No record in the library -888: Internal Error, please contact our operation team
customer_query_times_1/2/3/6/12months	Int	The number of customers that all family members have inquired about in our company in the past [1/2/3/6/12]months (de-duplicated)	Required	The meaning of the special value of the indicator: -999: No record in the library -888: Internal Error, please contact our operation team
family_query_count_1/2/3/6/12months	Int	The number of all family members queried by our company in the past [1/2/3/6/12]months	Required	The meaning of the special value of the indicator: -999: No record in the library -888: Internal Error, please contact our operation team

Ehe data dictionary of ”total_revenue_12months“

Range of Revenue	Level of Revenue
0	L0
(0, 1000000]	L1
(1000000, 2000000]	L2
(2000000,4000000]	L3
(4000000,6000000]	L4
(6000000,8000000]	L5
(8000000,10000000]	L6
(10000000,20000000]	L7
(20000000,50000000]	L8
(50000000, +)	L9

The data dictionary of ”avg_revenue_12months“

Range of Average Revenue	Level of Revenue
0	L0
(0, 500000]	L1
(500000, 1000000]	L2
(1000000,2000000]	L3
(2000000,3000000]	L4
(3000000,4000000]	L5
(4000000,5000000]	L6
(5000000,7000000]	L7
(7000000,9000000]	L8
(9000000, +)	L9

Response Example

{
    "result": {
        "query_info": {
            "family_query_count_12months": 2,
            "family_query_times_3months": 18,
            "family_query_count_1months": 2,
            "family_query_times_12months": 28,
            "family_query_count_6months": 2,
            "customer_query_times_12months": 2,
            "family_query_count_3months": 2,
            "family_query_times_6months": 26,
            "customer_query_times_1months": 1,
            "family_query_times_1months": 6,
            "customer_query_times_6months": 1,
            "customer_query_times_3months": 1
        },
        "personal_info": {
            "kk": "3203123412341234",
            "id_number": "3203123412341234",
            "gender": "Male",
            "birth_date": "1966-07-20 00:00:00",
            "name": "UJANG ABCDEFG",
            "birth_place": "CIANJUR",
            "family_type": "ANAK",
            "person_device_count_12months": 1,
            "religion": "ISLAM"
        },
        "family_basic_info": {
            "total_revenue_12months": "L0",
            "avg_revenue_12months": "L0",
            "family_gaji_count": 0,
            "family_permi_count": 3,
            "family_member_count": 6,
            "family_elder_count": 1,
            "family_child_count": 0,
            "family_device_count_12months": 2
        }
    },
    "code": 200,
    "sequence_id": "1717123412341234X3831234F1031234",
    "message": "Success"
}

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