API Format

Base URL

Singapore: https://sg.apitd.net/verification/persona/phone/pro/v1
America: https://us.apitd.net/verification/persona/phone/pro/v1
Germany: https://de.apitd.net/verification/persona/phone/pro/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

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

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
country_code	Integer	Country Code	required	Compliant with ITU E.164 standard, without '+ sign', without prefix 0, example: 86
phone_number	String	Phone Number	required	without '+ 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

code	Description
200	Success
301	Service not purchased
302	Traffic blocked
303	Traffic insufficient
304	Service expired
305	Daily maximum volume reached
9600	System error
9606	Illegal 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
}