API Reference
中文

International Phone Pro

API Format

Base URL

API

URLRequest MethodsContent-TypeOutput FormatCharacter Set
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

example: https://sg.apitd.net/verification/persona/phone/pro/v1?partner_code=test_code&partner_key=test_key

Authentication
ParameterTypeDescriptionRequired/OptionalNotes
partner_codeStringPartner Coderequiredassigned by TD
partner_keyStringPartner Keyrequiredassigned by TD

Request

ParameterTypeDescriptionRequired/OptionalNotes
country_codeIntegerCountry CoderequiredCompliant with ITU E.164 standard, without '+ sign', without prefix 0, example: 86
phone_numberStringPhone Numberrequiredwithout '+ sign'

Request Example

{
    "country_code": 86,
    "phone_number": "18700001111"
}

Response Parameter

Parameter

Type

Description

Notes

code

Integer

API Status Code

message

String

Status Message

specific abnormal reasons will be provided if the API is abnormal

sequence_id

String

Unique ID of Response

A unique ID used to mark each request

country_id

String

Country ID

country

String

Country

province

String

Province

city

String

City

operator

String

Operator

phone_type

String

Phone Type

enumeration:
fixed_line
mobile
prepaid
toll_free
voip
pager
payphone
invalid
restricted_premium
personal
voicemail
other

risk_score

Integer

Risk Score

range: 0 - 100

API Status Code

codeDescription
200Success
301Service not purchased
302Traffic blocked
303Traffic insufficient
304Service expired
305Daily maximum volume reached
9600System error
9606Illegal parameter

Response Example

{
  "code": 200,
  "message": "",
  "sequence_id": "1648777165770866F82AC7F326307055",
  "country_id": "CN",
  "country": "China",
  "province": "",
  "city": "Countrywide",
  "operator": "China Mobile",
  "phone_type": "mobile",
  "risk_score": 30
}