API Reference
中文

Indonesia Family Insights

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

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

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
resultObjectResult Required
personal_infoObjectPersonal InformationRequired
family_typeStringFamily TypeRequiredKEPALA KELUARGA
id_numberStringID numberRequired3526074107710317
kkStringkk Required
birth_placeStringPlace of BirthRequiredJAKARTA
nameStringNameRequiredNEMMOH
birth_dateStringDate of BirthRequired1973-07-01 00:00:00
religionStringReligionRequiredISLAM
genderStringGenderRequiredEnumeration value:
Male
Female
person_device_count_12monthsIntTotal number of personal devices in the past 12 months (deduplication)RequiredThe meaning of the special value of the indicator:
-999: No record in the library
-888: Internal Error, please contact our operation team
family_basic_infoObjectFamily Basic InformationRequired
family_member_countIntNumber of Family MembersRequired
family_child_countIntNumber of minor children (under 18 years old)Required
family_elder_countIntNumber of people aged 60 and aboveRequired
family_gaji_countintNumber of people with wage incomeRequired
family_permi_countintNumber of people paying insurance premiumsRequired
family_device_count_12monthsIntTotal number of household devices in the past 12 months (deduplication)RequiredThe meaning of the special value of the indicator:
-999: No record in the library
-888: Internal Error, please contact our operation team
total_income_12monthsStringTotal annual household revenueRequiredSee the data dictionary of ”total_revenue_12months“
avg_income_12monthsStringAverage annual household revenueRequiredSee the data dictionary of ”avg_revenue_12months“
query_infoObjectQuery InformationRequired
family_query_times_1/2/3/6/12monthsIntThe total number of inquiries of all family members in our company in the past [1/2/3/6/12]monthsRequiredThe 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/12monthsIntThe number of customers that all family members have inquired about in our company in the past [1/2/3/6/12]months (de-duplicated)RequiredThe 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/12monthsIntThe number of all family members queried by our company in the past [1/2/3/6/12]monthsRequiredThe 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 RevenueLevel of Revenue
0L0
(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 RevenueLevel of Revenue
0L0
(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 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