Phone Number

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

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 numberStrongly recommendedID number
id_typeStringID typeStrongly recommendedEnumeration 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_numberStringPhone numberRequiredThe maximum length is 19 digits, with country code, for example: 36301234567. If filled in, it must match with the country.
nameStringNameStrongly recommended
countryStringCountryRequired2-letter country code according to ISO 3166
Pakistan site only supports PK, Indonesia site only supports ID
emailStringEmailStrongly recommendedEmail 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

ParameterTypeDescriptionRequired/OptionalNotes
codeIntegerAPI status codeRequired
messageStringStatus InformationRequiredApecific abnormal reasons will be provided when the API is abnormal
sequence_idStringUnique response codeRequiredA unique ID used to track each request
phone_detectionObjectPhone DetectionRequired
account_infoObjectAccount informationRequired
history_infoObjectHistory InformationRequired
  • account_info data dictionary
ParameterTypeDescriptionRequired/OptionalNotes
phone_numberStringPhone numberRequired
validBooleanWhether it is validRequired
carrierStringCarrier of this phone numberRequired
activeStringIndicates phone number active statusRequiredEnumeration value:YES, NO, UNKNOWN
scoreStringThe possibility of fraud with this phone number, the higher the score, the higher the riskRequiredRange: 0-999
typeStringType of this phone numberRequiredType 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_registeredStringTotal number of registrationsRequired
registration_detailArrayRegistration detailRequired
  • registration_detail data dictionary
ParameterTypeDescriptionRequired/OptionalNotes
account_typeStringThe detected social networking sitesRequiredThe detected social networking sites are as follows: google, bukalapak, facebook, twitter, instagram, microsoft, telegram, whatsapp, viber, skype, amazon, linkedin
registeredBoolean/Intwhether registeredRequired
account_nameString/IntAccount nameRequiredOnly appears on: viber, skype
profile_photoString/IntPhotoRequiredOnly appears on: telegram, whatsapp, viber, skype
last_seenString/IntLast seenRequiredOnly appears on: telegram, whatsapp, viber
account_countryString/IntThe country where the account is locatedRequiredOnly appears on: skype
account_cityString/IntThe city where the account is locatedRequiredOnly appears on: skype
account_stateString/IntThe where the account is locatedRequiredOnly appears on: skype
account_idString/IntAccount idRequiredOnly appears on: google、skype
account_languageString/IntThe language the account usedRequiredOnly appears on: skype
full_nameString/IntFull nameRequiredOnly appears on: google
profile_genderString/IntGenderRequiredOnly appears on: skype,
1: Male;2: Female
profile_ageString/IntAgeRequiredOnly appears on: skype
profile_bioString/IntProfile bioRequiredOnly appears on: skype
profile_aboutString/IntAbout text of the profile.RequiredOnly appears on: whatsapp
profile_handleString/IntProfile handleRequiredOnly appears on: skype
  • history_info data dictionary
ParameterTypeDescriptionRequired/OptionalNotes
history_infoObjectHistory InformationRequired
hits_timeIntThe number of times the mobile phone number has been queried in our companyRequired
customer_hits_timeIntQuery the number of customers of this mobile phone number (remove duplicates)Required
first_seenIntThe first time any client looks up a phone number in UNIX time format and UTC time zone, without milliseconds.Required
last_seenIntThe last time any client looked up a mobile number in UNIX time format and UTC timezone, without milliseconds.Required

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
305Daily maximum volume reachedDaily maximum volume reachedNO
600Service Temporarily UnavailableService reached limitNO
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

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

Response Example-Failed

{
    "code": 11340,
    "sequence_id": "1720072040470369I30BC3538833****",
    "message": "Country error"
}