We recommend you start by making a test call to see how the API works. There are many different ways to make API requests, in this section we cover two ways in which you can send a test request to the API:

Follow the instructions below to send requests to the API from this page:

  1. Go to API specification and click the POST block, so that it expands.

  2. Click the Try it out button in the upper-right corner.

  3. Enter your token in the Auth-Token field.

  4. (Optional) Select true from the Add-Metadata dropdown, so the response also returns metadata information.

  5. (Optional) Enter an identifier in the Reference-Id field.

  6. (Optional) Enter a number between 2 and 15 in the Timeout-Seconds field.

  7. (Optional) Under phoneRequest, you can replace the values of the following fields

    Field Description
    number The phone number that you are submitting for validation, either in the format local to your country or with phone country code. The phone number must be enclosed in quotation marks, e.g. "01234567890".
    output_format The type of phone number formatting to be returned. Acceptable values:
    • E164 (default)
    • PLUS_E164
    • NATIONAL
    • 3-letter ISO country code, e.g. USA, GBR, AUS.

    Must be enclosed in quotation marks, e.g."NATIONAL".
    If not specified, the default format, E164, will be used.
    cache_value_days The number of days to look back in cache for the validation result for the phone number you are submitting for validation. If the result is cached, the response will be returned faster.Acceptable values: between 0 (no cache) and 30.If not specified, the default value, 7, will be used.
  8. (Optional) Select an option from the Parameter content type and Response content type dropdowns. Check out Supported data formats for more information.

  9. Click the Execute button to send the request to the API.

  10. View the response returned by the API under Responses > Server response. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out Response status codes to find out more about scenarios where the API returns errors.

Postman is a free, easy-to-use third-party application that you can use to send API calls.

Follow these instructions to send requests to the API via Postman:

  1. Download and install the free Postman app.

  2. Download this file and unzip it.

  3. Open the Postman app and click the Import button in the upper-left corner.
    Postman app view

  4. Import the file you've downloaded and unzipped.

  5. Go to the Collections tab on the left-hand side panel and click the API request you want to test.

  6. Go to the Headers tab.

  7. Replace the {{Auth-Token}} value with your token.

  8. Go to the Body tab.

  9. (Optional) You can replace the values of the following fields

    Field Description
    number The phone number that you are submitting for validation. The phone number must be enclosed in quotation marks, e.g. "01234567890".
    output_format The type of phone number formatting to be returned. Acceptable values:
    • E164 (default)
    • PLUS_E164
    • NATIONAL
    • 3-letter ISO country code, e.g. USA, GBR, AUS.

    Must be enclosed in quotation marks, e.g."NATIONAL".
    If not specified, the default format, E164, will be used.
    cache_value_days The number of days to look back in cache for the validation result for the phone number you are submitting for validation. If the result is cached, the response will be returned faster.Acceptable values: between 0 (no cache) and 30.If not specified, the default value, 7, will be used.
  10. Click the Send button to submit the API request.

  11. View the response returned by the API. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out Response status codes to find out more about scenarios where the API returns errors.