Validate a number

curl --request GET \
  --url https://api.wavix.com/v1/validation \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.wavix.com/v1/validation"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.wavix.com/v1/validation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v1/validation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wavix.com/v1/validation"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.wavix.com/v1/validation")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v1/validation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "success": false,
  "message": "Missing or invalid parameter <param_name>"
}

{
  "success": false,
  "message": "The service is not provisioned for your account."
}

GET

validation

Validate a number

curl --request GET \
  --url https://api.wavix.com/v1/validation \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.wavix.com/v1/validation"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.wavix.com/v1/validation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v1/validation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wavix.com/v1/validation"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.wavix.com/v1/validation")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v1/validation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "success": false,
  "message": "Missing or invalid parameter <param_name>"
}

{
  "success": false,
  "message": "The service is not provisioned for your account."
}

Authorizations

Authorization

string

header

required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

phone_number

string

required

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

Example:

"971569483322"

type

enum<string>

required

Depth of validation to perform. Accepts a PhoneNumberValidationType value. 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).

Available options:

format,

analysis,

validation

Response

Returns the phone number validation details.

phone_number

string

required

Phone number.

Example:

"971569483322"

valid

boolean

required

Indicates whether the phone number is valid.

Example:

true

country_code

string | null

required

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

Example:

"AE"

e164_format

string

required

Phone number in international E.164 format.

Example:

"+971569483322"

national_format

string

required

Phone number in the national format of the identified country.

Example:

"056 948 3322"

charge

string

required

Charge for the validation.

Example:

"0.015"

error_code

string

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:

"000"

ported

boolean | null

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

Example:

false

mcc

string | null

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

Example:

"424"

mnc

string | null

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

Example:

"004"

number_type

string | null

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

Example:

"mobile"

carrier_name

string | null

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

Example:

"Etisalat"

risky_destination

boolean | null

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

Example:

false

unallocated_range

boolean | null

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

Example:

false

reachable

boolean | null

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

Example:

true

roaming

boolean | null

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

Example:

false

timezone

string | null

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

Example:

"UTC+04:00"

Number status changed

Validate multiple numbers

⌘I

Using the APIs

API reference

WebSocket protocol

Validate a number

Authorizations

Query Parameters

Response