PVI – GetPhoneDetails

URL Endpoint
GetPhoneDetails Inputs
GetPhoneDetails Outputs

Our International Phone Validation service returns comprehensive carrier and exchange information, including ported status, SMS and MMS details and identifies high-risk VOIP and prepay phones.

URL Endpoint

JSON:
- https://trial.serviceobjects.com/PVI/GetPhoneDetails?Phone={PhoneNumber}&Country={Country}&Options=&AuthID={AuthID}

GetPhoneDetails Inputs

Name	Type		Description
Phone	String	Required	A variable digit phone number.
Country	String	Required	The location the phone number is in: 1-3 digit Country Calling Code, ISO2, ISO3, Country Name.*
Options	String	Optional	Comma separated list of possible options.
AuthID	String	Required	Your authentication identification provided by Service Objects. Sign up for a free trial key at https://www.serviceobjects.com/phone-insight/

* – Either one of these is a valid input or a country code has been included in the phone number.

GetPhoneDetails Outputs

PhoneDetails

Name	Type	Description
PhoneIn	String	The phone number parsed from the user input.
Score	Int	A 0-10 score that represent Service Objects Recommendation of the phone number, 1-10 being valid and 0 being an invalid phone.
CountryCode	Int	Is 1-3 digit country calling code
FormatNational	String	The provided phone number in a national format.
FormatInternational	String	The provided phone number in international format.
FormatE164	String	The provided phone number in E.164 format.
Extension	String	The extension on the phone number.
Locality	String	The locality from where the validated phone number belongs.
AdminArea	String	The administrative area from where the validated phone number belongs.
AdminAreaAbbr	String	The administrative area abbreviation from where the validated phone number belongs.
Country	String	The country to which the validated phone number belongs.
CountryISO2	String	The ISO 2 character country designation for a validated phone number.
CountryISO3	String	The ISO 3 character country designation for a validated phone number.
Latitude	Decimal	The latitude based on the latLongMatchLevel determined from the phone number of the provider.
Longitude	Decimal	The longitude based on the latLongMatchLevel determined from the phone number of the provider.
LatLongMatchLevel	String	The match level that the phone matched at: Country, LocalAdmin, Region or Locality.
TimeZones	timeZone[]	The time zone for the location of the phone number. If multiple possible zones are returned the most likely one will be listed first.
LineType	String	The line type determined for the phone number such as landline, wireless and VOIP.
ValidPhone	Boolean	A boolean response type determining whether the phone number is a valid phone number.
ValidPhoneLength	Boolean	A boolean response type determining whether the phone number is a valid phone number length for the country.
Notes	String[]	A list of notes giving additional information about the phone number.
Warnings	String[]	A list of warnings giving additional information about the phone number.
CurrentProvider	Provider	Details about the current provider.
PreviousProvider	Provider	Details about the previous provider.
OriginalProvider	Provider	Details about the original provider.
LastPortedDate	String Date	The last time the phone number was ported. Date in the format of YYYY-MM-DD.
SMSAddress	String	The SMS gateway address for the provided mobile number.

TimeZone

Name	Type	Description
ZoneName	String	The name of the time zone.
ZoneAbbr	String	The abbreviation of the time zone name.
CountryISO3	String	The ISO 3 character country designation for a validated phone number.
UTCOffset	String	The UTC offset, also known as the time offset, is a value that is either added to or subtracted from Coordinated Universal Time (UTC) to indicate the local solar time. It is important to note that the local solar time may differ from the current civil time, whether it is standard time or daylight saving time.

CurrentProvider

Name	Type	Description
ProviderName	String	The name of the line carrier of the phone number (“AT&T”).
ProviderID	String	The ID of the line carrier of the phone number.
CountryISO3	String	The ISO 3 character country designation for the current line carrier.

PreviousProvider

Name	Type	Description
ProviderName	String	The name of the previous line carrier of the phone number (“AT&T”).
ProviderID	String	The ID of the previous line carrier of the phone number.
CountryISO3	String	The ISO 3 character country designation for the previous line carrier.

OriginalProvider

Name	Type	Description
ProviderName	String	The name of the original line carrier of the phone number (“AT&T”).
ProviderID	String	The ID of the original line carrier of the phone number.
CountryISO3	String	The ISO 3 character country designation for the original line carrier.

Problem

Name	Type	Description
Type	String	The link to deeper details about the error.
Title	String	Basic description of the error.
Status	String	The status code of the error, these are http status codes for example 400 and 500 codes.
Detail	String	Description of the error.

*Also see PVI – Errors for service specific status code errors and Errors for general status code errors