Parse, validate and get location information about a phone number.
Use this API to validate local and international phone numbers in any country.
Determine the location of the number and reformat the number into local and international dialing formats.
We can also determine the line type (e.g. fixed or mobile) without the need to talk to the carrier network.
Please note however that type detection is not possible for all countries, notably most of the
In cases where the number type returns "unknown" you can utilize an HLR Lookup
to get carrier level type detection as well as more detailed mobile device information.
|number||Yes||string||A phone number. This can be in international format (E.164) or local format. If passing local format you should use the 'country-code' or 'ip' options as well|
|country-code||No||string||ISO 2-letter country code, assume numbers are based in this country.|
If not set numbers are assumed to be in international format (with or without the leading + sign)
|ip||No||string||Pass in a users IP address and we will assume numbers are based in the country of the IP address|
|valid||boolean||Is this a valid phone number|
|type||string||The number type, possible values are:|
- unknown (use HLR)
|is-mobile||boolean||True if this is a mobile number (with 100% certainty)|
|location||string||The phone number location. Could be a city, region or country depending on the type of number|
|country||string||The phone number country|
|country-code||string||The phone number country as an ISO 2-letter country code|
|international-calling-code||integer||The international calling code|
|international-number||string||The number represented in full international format (E.164)|
|local-number||string||The number represented in local dialing format|
|Free Tier||Tier 1||Tier 2||Tier 3|