number validation response

API Docs by APIMATIC

Number Validation Response

The response contains detailed information about the phone number. The list of parameters returned is determined by the type parameter passed in the request.

Fields

NameDescription
phone_number Required
String

The phone number sent in the request

valid Required
Boolean

Indicates if the phone number is valid or not

country_code Required
String

2-letter ISO code of the country of the phone number. null if the phone number is invalid.

e164_format Required
String

The phone number in the international E.164 format.

national_format Required
String

The phone number in the national format of the identified country.

ported Required
Boolean

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

mcc Required
String

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

mnc Required
String

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

number_type Required
String

Phone number type. Can be one of mobile, landline, or toll-free. null if the phone number is invalid.

carrier_name Required
String

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

risky_destination Required
Boolean

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

unallocated_range Required
Boolean

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

reachable Required
Boolean

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

roaming Required
Boolean

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

timezone Required
String

The time zone identified based on the phone number country and area code. null if the phone number is invalid

charge Required
String

Price of the validation.

error_code Required
String

Contains an error code if any. “000” indicates success. Other possible error_code values: 013 - Internal service error 021 - Invalid phone number length or format 041 - Request timeout 042 - Request failed 091 - Insufficient funds

{
  "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"
}