Sign in
Phone Validation

Submits a phone number to the service to be validated and returns the result of the validation.

post/phone/validate/v2

Headers

Add-Metadataboolean

Specify whether the response should return all fields and values, in addition to the main core information.

Reference-Idstring

Optional identifier that will be returned in the response to help you track the request.

Timeout-Secondsinteger

Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.

Request body

numberstring required

The phone number that is the subject of the validation.

output_formatstring nullable

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.

cache_value_daysinteger nullable

The number of days to look back in cache for the validation result for this phone number. If the result is cached, the response will be returned faster. Acceptable values from 0 (no cache) to 30. If not specified, the default value, 7, will be used.

country_isostring nullable

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_dateboolean

The date the phone number was last ported, returned only if the number has been moved to a different network. This is an optional field and is included only when get_ported_date is set to true, which incurs an additional click.

get_disposable_numberboolean nullable

A boolean indicator to attempt to verify if the number is known to be disposable. A disposable number is a shared mobile(or landline) that can be used to receive a text, or phone call.

Example request

{
  "number": "17087694383",
  "output_format": "NATIONAL",
  "get_ported_date": true,
  "get_disposable_number": true,
  "supplementary_live_status": {
    "mobile": [
      "USA"
    ],
    "landline": [
      "GBR"
    ]
  }
}

Response

OK

Example response

{
  "error": {
    "title": "Bad Request",
    "detail": "The request body was malformed."
  },
  "result": {
    "number": "17087694383",
    "validated_phone_number": "17087694383",
    "formatted_phone_number": "(708) 769-4383",
    "phone_type": "Mobile",
    "ported_date": "2012-06-27T09:32:09Z",
    "disposable_number": "Yes"
  },
  "metadata": {
    "phone_detail": {
      "original_operator_name": "T-Mobile",
      "original_network_status": "Available",
      "original_home_network_identity": "310200",
      "original_country_prefix": "1",
      "original_country_name": "United States of America",
      "original_country_iso": "USA",
      "operator_name": "Verizon",
      "network_status": "Available",
      "home_network_identity": "311480",
      "country_prefix": "1",
      "country_name": "United States of America",
      "country_iso": "USA",
      "is_ported": "Yes",
      "date_cached": "2020-04-22",
      "email_to_sms_address": "7087694383@vtext.com",
      "email_to_mms_address": "7087694383@vzwpix.com"
    }
  }
}

Changes

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