This document defines the input, output and behavior of the web service operations in GeoPhone. Each operation has its own unique behavior and output, although all of the operations are very similar.
Reverse-phone lookups are subject to federal rules determining who can procure data, and for what purpose. Currently, both disconnected and unlisted numbers return no contact information, and there are no public datasets regarding wireless numbers. GeoPhone returns contact information for connected landline phone numbers. Even in the cases that the phone number is disconnected or wireless, GeoPhone will commonly return the exchange information.
URL Endpoints
GetPhoneInfo_V2 Input
| Name | Type | Description |
|---|---|---|
| PhoneNumber | String | Phone number to look up, for example, “805-963-1700” |
| LicenseKey | String | Your license key to use the service. Sign up for a free trial key at https://www.serviceobjects.com/phone-insight/ |
GetPhoneInfo_V2 Outputs
| Name | Type | Description |
|---|---|---|
| Providers | Providers[] | Contains the results for the Provider Object |
| Contacts | Contacts[] | An array of contacts associated with the given phone numbers |
| Error | Error | Error Object Indicating why the service could not return a result |
- Providers Output
| Name | Type | Values | Description |
|---|---|---|---|
| Name | String | Varies | The name of the line carrier of the phone number (“AT&T”). |
| City | String | Varies | The city location of the carrier’s exchange (“New York”). |
| State | String | Varies | The state location of the carrier’s exchange (“NY”) |
| LineType [1] | String | LANDLINE, WIRELESS, UNKNOWN, VOIP |
The type of the phone line, can either be “Landline” or “Wireless” or “VOIP” or “Unknown”. |
| Latitude | String | Varies | The latitude coordinate for the phone number. |
| Longitude | String | Varies | The longitude coordinate for the phone number. |
| Quality | String | HIGH, MEDIUM, LOW |
This field is not currently used as all data sources are considered high quality. In the future there may be “other” sources that may not be as reliable. |
- Contacts Output
| Name | Type | Values | Description |
|---|---|---|---|
| Name | String | Varies | The name that the phone line is registered to. Can either be a person (“John Doe”) or a business (“Doe Corporation”). |
| Address | String | Varies | The street address to which the phone line is registered. |
| City | String | Varies | The city to which the phone line is registered. |
| State | String | Varies | The state to which the phone line is registered. |
| Zip | String | Varies | The zip code to which the phone line is registered. |
| Type | String | RESIDENTIAL, BUSINESS, UNKNOWN | The type of entity that owns the phone line, will be either “Residential” or “Business”. |