Batch Phone Verify
/api/v3/phone/verify
Batch Phone Verify: This endpoint lets you verify a batch of phone numbers. That is, it confirms whether or not the provided phone numbers are valid. Once verified, the service returns details about the phone numbers.
Input and Output: A JSON object containing a list of items, which is in turn a JSON map of fields. All field values are represented as strings.
Cost: The user is charged for each phone record (unless the API is not accessible).
Functionality: Each input is a JSON packet with a list of phone numbers. Output is a JSON list of items with verification details of all input phone numbers. The fields are described in the following table.
| Request Payload Attribute Name | Example | Description |
|---|---|---|
phoneNumber | 447528471411 | Phone number to be verified, in international format. |
networkCountry | US | If the phone number is given in national format, then ISO2 country code is required. |
id | 5 | Identifier for a phone number in the input payload that is mapped to the response payload. This value should be unique in each call. |
| Response Payload Attribute Name | Example | Description |
|---|---|---|
id | 5 | Identifier for a phone number in the input payload that is mapped to the response payload. This value should be unique in each call. |
PhoneNumber | 447528471411 | Phone number in international format. |
RequestProcessed | True | Returns True if the request processed. |
IsValid | Yes or Unknown | Returns Yes if the number is valid or Unknown if verification is not possible. |
NetworkCode | The operator code for the provided number. | |
NetworkName | The operator for the provided number. | |
NetworkCountry | The country code for the operator. | |
NationalFormat | 07528 471411 | The domestic network format (for use within the same country). |
CountryPrefix | 44 | The country prefix that must be prepended to the number when dialing internationally. |
NumberType | Landline | The type of number detected in the request (Mobile, Landline, or VOIP). |
Example Request
[{"id": "1","phoneNumber": "6502221111","networkCountry": "US"},{"id": "2","phoneNumber": "+919932221111"}]
Example Response
[{"PhoneNumber": "+16502221111","RequestProcessed": "true","IsValid": "Yes","NetworkCode": "985","NetworkName": "Comcast","NetworkCountry": "US","NationalFormat": "(650) 222-1111","CountryPrefix": "1","NumberType": "Landline","Id": "1"},{"PhoneNumber": "+919932221111","RequestProcessed": "true","IsValid": "Yes","NetworkCode": "92","NetworkName": "Bharti Airtel Ltd","NetworkCountry": "IN","NationalFormat": "09932221111","CountryPrefix": "91","NumberType": "Mobile","Id": "2"}]
Request
There are no request parameters for this operation.
- application/json; charset=UTF-8
Response
- application/json; charset=UTF-8
200 Response
object