Connect to the global mobile cellular network and retrieve the status of a mobile device.
The home location register (HLR) is a central database that contains details of each mobile phone subscriber connected to the global mobile network.
You can use this API to validate that a mobile number is live and registered on a mobile network in real-time.
Find out the carrier name, ported number status and fetch up-to-date device status information.
We don't charge for HLR lookups if we already know the number is not a valid mobile number.
This API automatically calls the Phone Validate API first to validate the number type without any need to connect to the carrier network.
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)
API Response
Parameter
Type
Description
number-valid
boolean
True if this a valid phone number
hlr-valid
boolean
Was the HLR lookup successful. If true then this is a working and registered cell-phone or mobile device (SMS and phone calls will be delivered)
hlr-status
string
The HLR lookup status, possible values are:
ok - the HLR lookup was successful and the device is connected
absent - the number was once registered but the device has been switched off or out of network range for some time
unknown - the number is not known by the mobile network
invalid - the number is not a valid mobile MSISDN number
fixed-line - the number is a registered fixed-line not mobile
voip - the number has been detected as a VOIP line
failed - the HLR lookup has failed, we could not determine the real status of this number
is-mobile
boolean
True if this is a mobile number (only true with 100% certainty, if the number type is unknown this value will be false)
is-ported
boolean
Has this number been ported to another network
is-roaming
boolean
Is this number currently roaming from its origin country
imsi
string
The mobile IMSI number (International Mobile Subscriber Identity)
mcc
string
The mobile MCC number (Mobile Country Code)
mnc
string
The mobile MNC number (Mobile Network Code)
msin
string
The mobile MSIN number (Mobile Subscription Identification Number)
msc
string
The mobile MSC number (Mobile Switching Center)
current-network
string
The currently used network/carrier name
origin-network
string
The origin network/carrier name
ported-network
string
The ported to network/carrier name (only set if the number has been ported)
number-type
string
The number type, possible values are:
mobile
fixed-line
premium-rate
toll-free
voip
unknown
location
string
The 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 number location as an ISO 2-letter country code
country-code3
string
The number location as an ISO 3-letter country code
currency-code
string
ISO 4217 currency code associated with the country
roaming-country-code
string
If the number is currently roaming, the ISO 2-letter country code of the roaming in country
international-calling-code
string
The international calling code
international-number
string
The number represented in full international format
local-number
string
The number represented in local dialing format
API Performance
Characteristic
Value
Description
Avg Latency
1-5s (variable)
This API has a non-deterministic latency based on outside factors
Max Rate
20/second
Maximum inbound request rate. Exceeding this will result in request throttling
Max Concurrency
50
Maximum concurrent/simultaneous requests. Exceeding this will result in error code 06 [TOO MANY CONNECTIONS]