Phone Numbers

Phone Number Validation

Validates a phone number and returns its country, its national and international formats, and the network it was originally assigned to.

Requires an API Key licensed for phone validation.

Every query decrements your lookup balance, including a number that fails to parse and a number reported as invalid.

get/phone_numbers

Request

  • Base URL: https://api.addresszen.com/v1
  • URL: https://api.addresszen.com/v1/phone_numbers
  • Auth: HTTP bearer

Query parameters

api_keystring

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

querystring required

Specifies the phone number to validate. Phone number must include a country code in an acceptable format. For instance, UK phone numbers should be prefixed with +44, 44 or 0044.

current_carrier'true'

When set to true, the API retrieves and populates the current network of the phone number.

This operation can be slow, depending on the network and local conditions.

tagsstring

Tags

A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

Response

Success

code2000 required
message'Success' required

Example response

{
  "result": {
    "national_format": "020 7112 8019",
    "international_format": "442071128019",
    "iso_country": "GBR",
    "iso_country_2": "GB",
    "country": "United Kingdom",
    "current_carrier": {
      "network_code": "234",
      "name": "BT Group",
      "country": "GB"
    },
    "original_carrier": {
      "network_code": "234",
      "name": "BT Group",
      "country": "GB"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.