Phone Number

This product is applicable for social network/media registration and information detection of the phone number.

API Method

Base URL

Indonesia: https://id.apitd.net/verification/kyc/phoneverify/v1
Singapore: https://sg.apitd.net/verification/kyc/phoneverify/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	Strongly recommended	ID number
id_type	String	ID type	Strongly recommended	Enumeration value: 1. identity_card: ID card 2. passport: passport 3. driving_licence: driving license 4. birth_certificate: birth certificate 5. voter_card: Voter card 6. tax_card: tax card 7. social_security_card: social security card 8. others: others
phone_number	String	Phone number	Required	The maximum length is 19 digits, with country code, for example: 36301234567. If filled in, it must match with the country.
name	String	Name	Strongly recommended
country	String	Country	Required	2-letter country code according to ISO 3166
email	String	Email	Strongly recommended	Email address, i.e.[email protected]

Request Example

{
    "country":"ID",
    "phone_number":"36301234567",
    "id_type":"identity_card",
    "id_number":"3310225629467",
    "name":"Joe",
    "email":"[email protected]"
}

Response Parameter

Parameter	Type	Description	Required/Optional	Notes
code	Integer	API status code	Required
message	String	Status Information	Required	Apecific 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
phone_detection	Object	Phone Detection	Required
account_info	Object	Account information	Required
history_info	Object	History Information	Required

account_info data dictionary

Parameter	Type	Description	Required/Optional	Notes
phone_number	String	Phone number	Required
valid	Boolean	Whether it is valid	Required
carrier	String	Carrier of this phone number	Required
active	String	Indicates phone number active status	Required	Enumeration value：YES, NO, UNKNOWN
score	String	The possibility of fraud with this phone number, the higher the score, the higher the risk	Required	Range: 0-999
type	String	Type of this phone number	Required	Type of phone based on the number. Types are: premium rate, toll free, shared cost, voip, personal number, pager, uan, voicemail, fixed line, mobile, unknown
total_registered	String	Total number of registrations	Required
registration_detail	Array	Registration detail	Required

registration_detail data dictionary

Parameter	Type	Description	Required/Optional	Notes
account_type	String	The detected social networking sites	Required	The detected social networking sites are as follows: google, bukalapak, facebook, twitter, instagram, microsoft, telegram, whatsapp, viber, skype, amazon, linkedin
registered	Boolean/Int	whether registered	Required
account_name	String/Int	Account name	Required	Only appears on: viber, skype
profile_photo	String/Int	Photo	Required	Only appears on: telegram, whatsapp, viber, skype
last_seen	String/Int	Last seen	Required	Only appears on: telegram, whatsapp, viber
account_country	String/Int	The country where the account is located	Required	Only appears on: skype
account_city	String/Int	The city where the account is located	Required	Only appears on: skype
account_state	String/Int	The where the account is located	Required	Only appears on: skype
account_id	String/Int	Account id	Required	Only appears on: google、skype
account_language	String/Int	The language the account used	Required	Only appears on: skype
full_name	String/Int	Full name	Required	Only appears on: google
profile_gender	String/Int	Gender	Required	Only appears on: skype, 1: Male;2: Female
profile_age	String/Int	Age	Required	Only appears on: skype
profile_bio	String/Int	Profile bio	Required	Only appears on: skype
profile_about	String/Int	About text of the profile.	Required	Only appears on: whatsapp
profile_handle	String/Int	Profile handle	Required	Only appears on: skype

history_info data dictionary

Parameter	Type	Description	Required/Optional
history_info	Object	History Information	Required
hits_time	Int	The number of times the mobile phone number has been queried in our company	Required
customer_hits_time	Int	Query the number of customers of this mobile phone number (remove duplicates)	Required
first_seen	Int	The first time any client looks up a phone number in UNIX time format and UTC time zone, without milliseconds.	Required
last_seen	Int	The last time any client looked up a mobile number in UNIX time format and UTC timezone, without milliseconds.	Required

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
305	Daily maximum volume reached	Daily maximum volume reached	NO
600	Service Temporarily Unavailable	Service reached limit	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

Response Example

{
    "code": 200,
    "phone_detection": {
        "account_info": {
            "score": 150.0,
            "active": "YES",
            "valid": true,
            "carrier": "China Unicom",
            "total_registered": 1,
            "phone_number": "86176****5618",
            "type": "MOBILE",
            "registration_detail": [
                {
                    "account_type": "bukalapak",
                    "registered": -999
                },
                {
                    "account_type": "linkedin",
                    "registered": -999
                },
                {
                    "account_type": "amazon",
                    "registered": -999
                },
                {
                    "account_type": "whatsapp",
                    "last_seen": -999,
                    "profile_photo": -999,
                    "profile_about": -999,
                    "registered": false
                },
                {
                    "account_type": "skype",
                    "account_language": -999,
                    "profile_photo": -999,
                    "profile_gender": -999,
                    "registered": false,
                    "profile_bio": -999,
                    "profile_handle": -999,
                    "account_id": -999,
                    "profile_age": -999,
                    "account_name": -999,
                    "account_city": -999,
                    "account_country": -999,
                    "account_state": -999
                },
                {
                    "account_type": "twitter",
                    "registered": false
                },
                {
                    "account_type": "facebook",
                    "registered": false
                },
                {
                    "account_type": "telegram",
                    "last_seen": -999,
                    "profile_photo": -999,
                    "registered": false
                },
                {
                    "account_type": "google",
                    "account_id": -999,
                    "full_name": -999,
                    "registered": true
                },
                {
                    "account_type": "instagram",
                    "registered": false
                },
                {
                    "account_type": "microsoft",
                    "registered": false
                },
                {
                    "account_type": "viber",
                    "last_seen": -999,
                    "profile_photo": -999,
                    "account_name": -999,
                    "registered": false
                }
            ]
        },
        "history_info": {
            "customer_hits_time": 1,
            "first_seen": 1710842026,
            "hits_time": 1,
            "last_seen": 1710842026
        }
    },
    "sequence_id": "1710842026384800G104C24D38339515",
    "message": "success"
}