HLR Lookup
Ask the mobile network whether a number is live, reachable and where it is registered.
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"}'{
"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>requiredYour 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>requiredPhone number. Mobile numbers only. Landlines return a not-applicable status at no charge. Example: +15125550142
freshbooleanSkip the 7-day cache and run a new lookup. Charged as a normal lookup.
referencestringYour 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.
successbooleantrue when the lookup ran.
data.statusstringactive, absent, dead or not_applicable. Active means the network knows the subscriber and can reach the handset.
data.current_network.namestringThe operator serving the number at the time of the query.
data.current_network.mccstringMobile country code of the serving network.
data.current_network.mncstringMobile network code of the serving network. With the MCC it identifies one operator.
data.original_network.namestringThe operator the number range was first allocated to.
data.portedbooleantrue when the current network differs from the original one.
data.roamingbooleantrue when the subscriber is attached to a network outside their home country.
data.countrystringISO country code the number belongs to.
meta.credits_usednumberCredits charged for this call.
meta.credits_remainingnumberYour balance after the call.
meta.cachedbooleantrue when the result came from the 7-day cache.
meta.request_idstringQuote 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.
| HTTP | Code | Meaning |
|---|---|---|
| 401 | unauthorized | The key is missing, malformed or revoked. |
| 402 | insufficient_credits | Your credits are used up and pay as you go is off or at its limit. |
| 422 | invalid_input | A field is missing or malformed. The field property names it. |
| 429 | rate_limited | Too many requests for this key. Wait for the Retry-After interval. |
| 500 | internal_error | Something failed on our side. Safe to retry. |
| 503 | source_unavailable | An 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