Phone Verification API
METHODS
CheckPhoneNumber
Use the CheckPhoneNumber method to validate and get info about a single phone number. (Use CheckPhoneNumbers to check multiple numbers.)
Syntax
CheckPhoneNumber(PhoneNumber, LicenseKey)
Request Parameters
| Parameter Name | Description | Data Type | Required | Sample Value |
|---|---|---|---|---|
| PhoneNumber | The phone number that you want to check. | String | True | 7575449510 |
| LicenseKey | Your license key. | String | True | 00000000-0000-0000-0000-000000000000 |
Response
Returns: PhoneReturn object
CheckPhoneNumbers
Use the CheckPhoneNumbers method to validate and get info about multiple phone numbers at once.
Syntax
CheckPhoneNumbers(PhoneNumbers, LicenseKey)
Request Parameters
| Parameter Name | Description | Data Type | Required | Sample Value |
|---|---|---|---|---|
| PhoneNumbers | One or more phone numbers that you want to check. | Array of String values | True | 7575449510 |
| LicenseKey | Your license key. | String | True | 00000000-0000-0000-0000-000000000000 |
Response
Returns: Array of PhoneReturn objects
TYPES
PhoneReturn
This data type contains all the info retrieved by the Phone Verification API about a given phone number. It is returned by the CheckPhoneNumber and CheckPhoneNumbers methods.
Type Properties
| Property Name | Description | Data Type | Sample |
|---|---|---|---|
| Company | Operating company name. | String | LEVEL 3 COMMUNICATIONS, LLC – VA |
| Valid | Indicates whether the phone number is valid. | Boolean | True |
| Use | Use of the phone number. | String | Assigned to a code holder for normal use. |
| State | State abbreviation. | String | VA |
| Switch | Switch information. | String | |
| RC | Rate Center. This is the geographic area used by exchange carriers to set rate boundaries for billing and for issuing phone numbers. | String | PARKSLEY |
| OCN | Operating Company Number. This unique number identifies the operating company. | String | 8825 |
| OriginalNumber | Original phone number as submitted to the API. | String | (757) 544-9510 |
| CleanNumber | Phone number as cleaned and standardized by the API. | String | 7575449510 |
| SwitchName | Switch name. | String | NORFOLK |
| SwitchType | Switch type. | String | |
| Country | Country that the phone number is from. | String | United States |
| CLLI | Common Language Location Identifier code. | String | CHSKVAAYDS0 |
| PrefixType | Type of company. | String | CLEC – (Competitive Local Exchange Carrier) |
| LATA | Local Access and Transport Area. This number indicates a market area within the United States. For example, 252 represents the Norfolk, VA area. | String | 252 |
| sms | Type of SMS that the phone number uses. | String | CLEC – (Competitive Local Exchange Carrier) |
| Empty string. (This used to indicate the type of email that the SMS uses.) | String | ||
| AssignDate | Date when the phone number was issued to a person. | String | 9/26/2005 |
| TelcomCity | City that the phone number belongs to. | String | New Brunswick |
| TelcomCounty | County that the phone number belongs to. | String | Middlesex |
| TelcomState | State that the phone number belongs to. | String | VA |
| TelcomZip | ZIP Code that the phone number belongs to. | String | 8901 |
| TimeZone | Time zone that the phone number belongs to. | String | EST |
| Lat | Latitude of the telecom address. | String | 36.8894 |
| Long | Longitude of the telecom address. | String | -76.2382 |
| Wireless | Indicates whether the phone number is wireless. | Boolean | false |
| LRN | Location Routing Number. This unique 10-digit number represents a telephone switch through which multiple phone numbers are routed. The LRN enables Local Number Portability (LNP), which allows phone numbers to be ported to different carriers. Note that toll-free numbers do not return LRN information. | String | 7573740000 |
Let’s start sending, together.