| Name | Type | Description |
|---|---|---|
| Auth-Token | string | Input your unique token here. This is required to submit an API request. |
| Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
| Name | Type | Description | |
|---|---|---|---|
| defaults (Optional) |
object | Object defining the default options that apply to all the phone numbers. | |
| output_format (Optional) |
string | The desired format of the phone number: E164, PLUS_E164, NATIONAL, any 3-letter ISO country code. If not specified, the default format, E164, will be used. | |
| country_iso (Optional) |
string | You can indicate the 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code. | |
| get_ported_date (Optional) |
boolean | A boolean indicator to attempt to retrieve the last ported date of the phone number. Please note that this feature is available for selected countries and there would be additional charge if a date is successfully retrieved. | |
| supplementary_live_status (Optional) |
string |
|
|
| phones | collection | Collection of phone numbers. Currently, up to 10,000 phone numbers are supported. | |
| number | string | The phone number that you are submitting for validation, either in the format local to your country or with phone country code. | |
| country_iso (Optional) |
string | You can indicate the 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code. This will overwrite the country_iso in the default parameter. | |
The response from the API returns the below fields within a result object. Should an error occur, an error object is returned instead.
| Name | Type | Description |
|---|---|---|
| batch_id | string | The Batch ID. |
| status | string | The current status of the Batch. |
The following response codes can be returned by the API:
| HTTP status code | Title | Scenario |
|---|---|---|
| 200 | Success | You've submitted a successful request and a valid response was returned. |
| 400 | Bad Request | You've submitted an invalid phones field. The phones field must be an array with minimum length of 1 and maximum length of 10,000. |
| You've submitted an invalid number. The number field must be less than 1000 characters. | ||
| You've submitted an invalid output_format. The output_format field must be E164, PLUS_E164, NATIONAL or any 3-letter ISO country code. | ||
| You've submitted an invalid country_iso. | ||
| You've specified an unsupported country ISO code for "supplementary_live_status" in either the "Mobile" or "Landline" fields. Try submitting another request and make sure you enter an ISO code that is supported. | ||
| You didn't provide an authentication token. Try submitting another request and make sure you specify your token, which you can find by signing in to the Self Service Portal. | ||
| You've submitted a malformed request body. Try sending another call and make sure the request body contains all required fields and that they are formatted correctly. | ||
| You've submitted an empty request body. Try sending another call and make sure the request body contains all required fields. | ||
| You've submitted an invalid Reference-ID header. Try submitting another request and make sure this header is formatted correctly. | ||
| You've submitted an invalid Add-Metadata header. Try submitting another request and make sure this header is formatted correctly. | ||
| 401 | Unauthorized | The authentication token you've provided is incorrect. Sign in to the Self Service Portal to find the right token. |
| 403 | Forbidden | The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. |
| The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. | ||
| The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain. | ||
| The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address. | ||
| 404 | Not Found | The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact us. |
| 406 | Not Acceptable | You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. Check out Supported data formats for details. |
| 415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. Check out Supported data formats for details. |
| 429 | Too Many Requests | You've submitted too many requests. To protect all customers, your account has been temporarily throttled. Check out Rate limiting for details. |
| 500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact us. |
| 503 | Service Unavailable | The service is currently unavailable. You can check the API's uptime and downtime by going to our service status page. |
Successful API request returns the response within a result object. However, should an error occur, an error object is returned instead with the below fields.
| Name | Type | Description |
|---|---|---|
| type | string | A link to documentation that provides more details about the error you've encountered. |
| title | string | The title of the error. |
| detail | string | A description of the error. |
| instance | string | The endpoint that returned the error. |
{
"defaults": {
"output_format": "PLUS_E164",
"country_iso": "GBR",
"get_ported_date": true,
"supplementary_live_status": {
"landline": [
"GBR"
]
}
},
"phones": [
{
"number": "1234567890"
}
]
}
{
"result": {
"batch_id": "<batch_id>",
"status": "submitted"
}
}