Phone Verify
/api/v3/phone/verify
Phone Verify: This endpoint provides a way to verify a phone number; that is, it confirms whether or not the provided phone number is valid. Once verified, the service returns a list of items with all the details pertaining to the verified phone number.
The API accepts the following inputs:
1. Phone number - Number to be verified in international format.
2. Country - If the phone number is given in national format, then ISO2 country code is mandatory for validating the number.
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 the record, unless the API is not accessible for some reason.
Functionality: Each input is a query parameter and output is a JSON list of items. The fields are described in the following table.
| Name | Example | Description |
|---|---|---|
PhoneNumber | 447528471411 | The recipient phone number in international format. |
RequestProcessed | True | Returns true if the request processed, or false if the validation attempt was unsuccessful. |
IsValid | Yes or Unknown | Returns yes if the number is valid, or unknown if validation wasn't possible. |
NetworkCode | The current operator serving the supplied number. | |
NetworkName | The name of the current operator serving the supplied number. | |
NetworkCountry | The country code of the operator. | |
NationalFormat | 07528 471411 | The domestic network format (useful for dialling from within the same country). |
CountryPrefix | 44 | The country prefix that must be prepended to the number when dialling internationally. |
NumberType | Landline | The type of number that was detected in the request (MOBILE, LANDLINE OR VOIP). |
Example Response
{
"Items": [
{
"PhoneNumber": "+16505038025",
"RequestProcessed": "true",
"IsValid": "Yes",
"NetworkCode": "",
"NetworkName": "Comcast",
"NetworkCountry": "US",
"NationalFormat": "(650) 503-8025",
"CountryPrefix": "1",
"NumberType": "Landline",
"type": "phone"
}
]
}
Request
-
Country(required): string
Default Value:
-
Phone(required): string
There's no request body for this operation.
Back to TopResponse
- application/json; charset=UTF-8
200 Response
object