Use this Restful endpoint to validate and format landline or mobile phone numbers, using the POST method.
Related Phone documentation:
- Phone introduction
- Restful Phone GET request
- Restful Phone response
- Restful Phone Swagger documentation
Restful Phone POST request
Endpoint
POST https://{SERVER_ADDRESS}/{VERSION}/phone/lookupSend the following parameters in the request body using JSON.
| Parameter | Description | Mandatory/Optional |
|---|---|---|
| country | ISO 3-letter country code. | Mandatory |
| phone | Phone number to validate. | Mandatory |
| format | Desired output format. | Optional |
| status | Set to true to enable additional status verification when available. |
Optional |
| timeout | Maximum query time for verification, in seconds. | Optional |
| separator | Separator character used in the formatted phone number. | Optional |
Example:
{
"country": "FRA",
"phone": "0611223344",
"format": 2,
"status": true,
"timeout": 0.5,
"separator": "."
}Format values
| Value | Description |
|---|---|
0 |
Phone number without spaces. |
1 |
Phone number with a space every two digits. |
2 |
Phone number in international format with spaces. |
3 |
Phone number in compact international format. |
4 |
Phone number in international format with national prefix. |
5 |
Phone number in compact international format without spaces. |
6 |
Phone number in international format with national prefix and spaces. |
7 |
Phone number separated with dots, France only. |
8 |
Phone number in international format separated with dots. |
9 |
Phone number with country code without plus sign. |
Related to