WAwavix
Number validator

Validate a number

Changed on

Validates a single phone number and returns line type, carrier, portability, and reachability details. The response's error_code is a per-number result code (000 success; 013 internal error; 021 invalid format; 041 remote timeout; 042 remote query failed; 091 insufficient funds) — distinct from the HTTP status codes below.

get/v1/validation

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/validation
  • Auth
    HTTP bearer

Query parameters

phone_numberstring required
Example:971569483322

The phone number to validate, in E.164 format with or without the leading +.

type'format' | 'analysis' | 'validation' required

Depth of validation to perform on the phone number. One of format (checks number syntax only), analysis (returns number metadata such as type and country), or validation (performs a live network lookup of the number's current status).

Depth of validation to perform. Accepts a PhoneNumberValidationType value.

Response

Returns the phone number validation details.

phone_numberstring required

Phone number.

validboolean required

Indicates whether the phone number is valid.

country_codestring nullable required

ISO 3166-1 alpha-2 country code of the phone number. null if the number is invalid.

e164_formatstring required

Phone number in international E.164 format.

national_formatstring required

Phone number in the national format of the identified country.

portedboolean nullable

Indicates whether the phone number was ported or not. null if the phone number is invalid.

mccstring nullable

Mobile Country Code of the phone number carrier. For mobile phone numbers only. null if the phone number is invalid.

mncstring nullable

Mobile Network Code of the phone number carrier. For mobile phone numbers only. null if the phone number is invalid

number_typestring nullable

Number type. Possible values are mobile, landline, or toll-free. null if the phone number is invalid.

carrier_namestring nullable

Name of the phone number carrier. null if the phone number is invalid.

risky_destinationboolean nullable

Indicates whether the phone number belongs to a number range associated with traffic pumping. null if the number is invalid.

unallocated_rangeboolean nullable

Indicates whether the phone number belongs to an unallocated number range. null if the number is invalid

reachableboolean nullable

Indicates whether the number is registered in a mobile network. For mobile phone numbers only. null if the number is invalid

roamingboolean nullable

Indicates whether the number is roaming. For mobile phone numbers only. null if the number is invalid

timezonestring nullable

Time zone based on the phone number's country and area code. null if the number is invalid.

chargestring required

Charge for the validation.

error_codestring required

Error code for the request. 000 indicates success. Possible values:

  • 013: — Internal service error
  • 021: — Invalid phone number length or format
  • 041: — Request timeout
  • 042: — Request failed
  • 091: — Insufficient funds

Example response

{
  "phone_number": "971569483322",
  "valid": true,
  "country_code": "AE",
  "e164_format": "+971569483322",
  "national_format": "056 948 3322",
  "mcc": "424",
  "mnc": "004",
  "number_type": "mobile",
  "carrier_name": "Etisalat",
  "reachable": true,
  "timezone": "UTC+04:00",
  "charge": "0.015",
  "error_code": "000"
}

Changes

  • d4db3aae3627Revision changes
    • breaking

      the query request parameter type was restricted to a list of enum values

    • info

      added the new enum value analysis to the query request parameter type

    • info

      added the new enum value format to the query request parameter type

    • info

      added the new enum value validation to the query request parameter type

    • info

      for the query request parameter type, the type was generalized from no type to string

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status