API output elements

A successful lookup of a telephone number will return information about the number supplied.

Generic response body fields

Field Description
ResultCode Status code of the submitted phone. See result codes for details.
Certainty Description of the ResultCode
PhoneType Type of the submitted phone number, e.g. "LandLine", "Mobile", "Provided number is Invalid"
Number Phone number supplied

UK, Ireland, France, Australia and Singapore specific

Field Description
ValidatedPhoneNumber Verified number in international format without the leading "+", e.g. "447123456789"
CountryCode Home country relating to the phone number, e.g. "44"
CountryIso Country ISO alpha-2 code relating to the phone number, e.g. "Gb"
CountryName Name of the country relating to the phone number, e.g. "United Kingdom"
OperatorName Company name of the MSISDN Operator, e.g. "T-Mobile"
OperatorAlias Alternate name for the MSISDN Operator, e.g. "One2one"
OperatorCountryIso Country ISO alpha-2 code relating to the operator. If the UK mobile telephone is roaming internationally, the ISO code will show the country in which the phone is currently connected.
OperatorCountryName Name of the country relating to the operator. If the UK mobile telephone is roaming internationally, the country name will show the country in which the phone is currently connected.
PortedStatus "Yes" or "No" indicating whether the mobile number is ported from one operator to another.
PortedOperatorName Operator from which the mobile number is ported.
PortedOperatorAlias Alternate name for the operator from which the mobile number is ported.

USA and Canada specific

Field Description
PointCode Similar to an IP address in an IP network. It is a unique address for a node to identify the destination of a message signal unit.
DaylightSavingObserved "Yes" or "No" indicating Daylight Time Saving flag.
Dialable "Yes" or "No" indicating dialable flag.
StateProvince State or province of the phone number.
TimeZone Timezone of the phone number.

Examples

Field Example
PointCode 0 = non-protected 48 states, Alaska, Hawaii
1 = protected code
2 = Canadian
3 = Caribbean
4 = Mexican
5 = 900 service number
6 = PCS
StateProvince AL = Alabama
AK = Alaska
AZ = Arizona
AR = Arkansas
CA = California
CO = Colorado
CT = Connecticut
DE = Delaware
DC = District of Columbia
FL = Florida
GA = Georgia
HI = Hawaii
ID = Idaho
IL = Illinois
IN = Indiana
IA = Iowa
KS = Kansas
KY = Kentucky
LA = Louisiana
ME = Maine
MD = Maryland
MA = Massachusetts
MI = Michigan
MN = Minnesota
MS = Mississippi
MO = Missouri
MT = Montana
NE = Nebraska
NV = Nevada
NH = New Hampshire
NJ = New Jersey
NM = New Mexico
NY = New York
NC = North Carolina
ND = North Dakota
OH = Ohio
OK = Oklahoma
OR = Oregon
PA = Pennsylvania
RI = Rhode Island
SC = South Carolina
SD = South Dakota
TN = Tennessee
TX = Texas
UT = Utah
VT = Vermont
VA = Virginia
WA = Washington
WV = West Virginia
WI = Wisconsin
WY = Wyoming
AS = American Samoa
FM = Federated States of Micronesia
GU = Guam
MH = Marshall Islands
NN = CNMI (N. Marianas)
PW = Palau
PR = Puerto Rico
UM = U.S. Minor Outlying Islands
VI = U.S. Virgin Islands
AI = Anguilla
AN = Antigua
BA = Bahamas
BD = Barbados
BM = Bermuda
BV = British Virgin Islands
CQ = Cayman Islands
DM = Dominica
DR = Dominican Republic
GN = Grenada
JM = Jamaica
RT = Montserrat
KA = St. Kitts & Nevis
SA = St. Lucia
ZF = St. Vincent
TR = Trinidad & Tobago
TC = Turks & Caicos
AB = Alberta
BC = British Columbia
MB = Manitoba
NB = New Brunswick
NF = Newfoundland
NT = Northwest Territory
NS = Nova Scotia
VU = Nunavut Territory
ON = Ontario
PE = Prince Edward Island
PQ = Quebec
SK = Saskatchewan
YT = Yukon Territory
MX = Mexico
Time Zone 0 = not applicable
1 = Samoa
2 = Hawaii
3 = Alaska/ Yukon
4 = Pacific
5 = Mountain
6 = Central
7 = Eastern
8 = Atlantic
9 = Newfoundland