Spreadsheet Upload

CSV Requirements

The uploaded CSV file must follow these requirements to be processed correctly:

Contains the column "phone_number"

Does not exceed 10,000 rows

Uses the ISO 3166-1 alpha-2 country codes for the optional column "country"

Fields Requirement

At least one attribute from the list of available output fields is selected

Field	Description
Country	ISO 3166-1 alpha-2 country code
Valid	Boolean value indicating whether or not a particular number is valid
State/ Region	State or region based upon US area code
National Number Field	The national number formatted number including special characters such as parentheses and dashes
International Number Field	The international formatted number including special characters such as parentheses and dashes
E.164 Number	The international formatted number including special characters such as parentheses and dashes
E.164 Unformatted Number	The international unformatted number with special characters omitted
Valid Types	Valid phone number types (ie. Mobile, Landline)

Resulting CSV File

If the uploaded CSV file is valid, a resulting CSV file will automatically be downloaded. The resulting CSV file appends the selected fields to the uploaded CSV file. If a phone number is invalid, the additional fields will remain blank.

phone_number	country	valid	national	e164_formatted	valid_type
8552596624	US	true	(855) 259-6624	+18552596624	Toll Free
12345	US	false
228943629	TW	true	02 2894 3629	+886228943629	Landline

API

POST command

Validate up to 10,000 phone numbers with associated country.

URL	/api/v1/validate
Data Parameters	{"numbers": [ {"number": "8552596624", "country": "US"}, {"number": "3173219898"} ]}
Maximum Phone Number Count in an API Call	10,000
Success Response Code (for valid and invalid numbers)	200
Success Response Content (for valid numbers)	{"results" : [ { "valid": true, "original_number": "8552596624", "country": "US", "national_number": "(855) 259-6624", "national_unformatted_number": "8552596624", "international_number": "+1 855-259-6624", "e164_number": "+18552596624", "e164_unformatted_number": "18552596624", "valid_types": "Toll Free" }, { "valid": true, "original_number": "3173219898", "country": "US", "national_number": "(317) 321-9898", "national_unformatted_number": "3173219898", "international_number": "+1 317-321-9898", "e164_number": "+13173219898", "e164_unformatted_number": "13173219898", "valid_types": "Landline, Mobile" } ]}
Success Response Content (with invalid numbers)	{"results" : [ { "valid": true, "original_number": "8552596624", "country": "US", "national_number": "(855) 259-6624", "national_unformatted_number": "8552596624", "international_number": "+1 855-259-6624", "e164_number": "+18552596624", "e164_unformatted_number": "18552596624", "valid_types": "Toll Free" }, { "valid": false, "original_number": "123", "country": "US", } ]}
Error Response Code	400
Error Response Content	{"error": "invalid parameters to API method"} {"error": "exceeded 10,000 phone numbers to process"}