---
title: "HLR Lookup"
method: GET
path: "/hlr-lookup"
tags: ["Telephony"]
---

# HLR Lookup

`GET /hlr-lookup`

Connect to the global mobile cellular network and retrieve the status of a mobile device

## Query parameters

- `number` string, required
- `country-code` string

## Response `200`

OK

- HLRLookupResponse — Structure of hlr-lookup
  - `number-valid` boolean, required — True if this a valid phone number
  - `international-calling-code` string, required — The international calling code
  - `mnc` string, required — The mobile MNC number (Mobile Network Code)
  - `number-type` string, required — The number type, possible values are: <br> <ul> <li>mobile</li> <li>fixed-line</li> <li>premium-rate</li> <li>toll-free</li> <li>voip</li> <li>unknown</li> </ul>
  - `hlr-valid` boolean, required — 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, required — The HLR lookup status, possible values are: <br> <ul> <li>ok - the HLR lookup was successful and the device is connected</li> <li>absent - the number was once registered but the device has been switched off or out of network range for some time</li> <li>unknown - the number is not known by the mobile network</li> <li>invalid - the number is not a valid mobile MSISDN number</li> <li>fixed-line - the number is a registered fixed-line not mobile</li> <li>voip - the number has been detected as a VOIP line</li> <li>failed - the HLR lookup has failed, we could not determine the real status of this number</li> </ul>
  - `ported-network` string, required — The ported to network/carrier name (only set if the number has been ported)
  - `imsi` string, required — The mobile IMSI number (International Mobile Subscriber Identity)
  - `mcc` string, required — The mobile MCC number (Mobile Country Code)
  - `international-number` string, required — The number represented in full international format
  - `local-number` string, required — The number represented in local dialing format
  - `country-code` string, required — The number location as an ISO 2-letter country code
  - `is-ported` boolean, required — Has this number been ported to another network
  - `msin` string, required — The mobile MSIN number (Mobile Subscription Identification Number)
  - `location` string, required — The number location. Could be a city, region or country depending on the type of number
  - `origin-network` string, required — The origin network/carrier name
  - `is-mobile` boolean, required — True if this is a mobile number (only true with 100% certainty, if the number type is unknown this value will be false)
  - `is-roaming` boolean, required — Is this number currently roaming from its origin country
  - `country` string, required — The phone number country
  - `country-code3` string, required — The number location as an ISO 3-letter country code
  - `currency-code` string, required — ISO 4217 currency code associated with the country
  - `roaming-country-code` string, required — If the number is currently roaming, the ISO 2-letter country code of the roaming in country
  - `msc` string, required — The mobile MSC number (Mobile Switching Center)
  - `current-network` string, required — The currently used network/carrier name
  - `network-tags` string, required — Contains any additional details about the current network such as former network names and mobile technology utilized

## Other responses

- `400` — Your API request has been rejected. Check error code for details
- `403` — You have failed to authenticate
- `500` — We messed up, sorry! Your request has caused a fatal exception
- `default` — We messed up, sorry! Your request has caused an error

---

[API](https://skmtc.net/neutrinoapi/apis/neutrino-api.md) · [All operations](https://skmtc.net/neutrinoapi/apis/neutrino-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/neutrinoapi/neutrino-api/revisions/4ebd6b56de42/schema)