Skip to content
Phone

HLR Lookup

Ask the mobile network whether a number is live, reachable and where it is registered.

POST/v1/hlr-lookup
5 creditsBulk supportedGlobal mobile networks
Request
curl -X POST https://api.1lookup.dev/v1/hlr-lookup \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone_number":"+15125550142"}'
Response
{
  "success": true,
  "data": {
    "phone_number": "+15125550142",
    "status": "active",
    "country": "US",
    "current_network": {
      "name": "Example Wireless",
      "mcc": "310",
      "mnc": "999"
    },
    "original_network": {
      "name": "Contoso Mobile",
      "mcc": "310",
      "mnc": "998"
    },
    "ported": true,
    "roaming": false
  },
  "meta": {
    "credits_used": 5,
    "credits_remaining": 999,
    "cached": false,
    "request_id": "req_8f3a2c1e9b7d"
  }
}

Authorization

Authorizationstring<bearer>required

Your API key as a Bearer token. Live keys start with 1lk_live_. Test keys start with 1lk_test_ and return this endpoint's sample response without spending credits. See authentication.

Body

Send the fields as a JSON object with Content-Type: application/json.

phone_numberstring<E.164>required

Phone number. Mobile numbers only. Landlines return a not-applicable status at no charge. Example: +15125550142

freshboolean

Skip the 7-day cache and run a new lookup. Charged as a normal lookup.

referencestring

Your own identifier, echoed back in meta and shown in lookup history.

Response

A 200 response carries the result in data and the cost of the call in meta. These are the fields most integrations read.

successboolean

true when the lookup ran.

data.statusstring

active, absent, dead or not_applicable. Active means the network knows the subscriber and can reach the handset.

data.current_network.namestring

The operator serving the number at the time of the query.

data.current_network.mccstring

Mobile country code of the serving network.

data.current_network.mncstring

Mobile network code of the serving network. With the MCC it identifies one operator.

data.original_network.namestring

The operator the number range was first allocated to.

data.portedboolean

true when the current network differs from the original one.

data.roamingboolean

true when the subscriber is attached to a network outside their home country.

data.countrystring

ISO country code the number belongs to.

meta.credits_usednumber

Credits charged for this call.

meta.credits_remainingnumber

Your balance after the call.

meta.cachedboolean

true when the result came from the 7-day cache.

meta.request_idstring

Quote this when you contact support.

Errors

A failed request returns success: false with an error object, and is never charged. The full list is on the errors page.

HTTPCodeMeaning
401unauthorizedThe key is missing, malformed or revoked.
402insufficient_creditsYour credits are used up and pay as you go is off or at its limit.
422invalid_inputA field is missing or malformed. The field property names it.
429rate_limitedToo many requests for this key. Wait for the Retry-After interval.
500internal_errorSomething failed on our side. Safe to retry.
503source_unavailableAn upstream source did not answer in time. Safe to retry.

Billing

5 credits. Charged when the lookup runs and returns a result. Errors are never charged, and repeating the same input within 7 days is served from cache at no charge.

Product overview and use cases