HLR Lookup Documentation

The HLR Lookup Developer Hub

Welcome to the HLR Lookup help pages. Here you'll find all the information you need to get started with our API or batch upload services.
Search the docs for explanations on the results you'll receive and a breakdown of all the possible parameters available.

Status Information

type
Info
Field Type

type

Expect: Mobile Indicates that this is a valid mobile number

String

msisdn

The number used for the lookup

String

error_code

Expect one of the following. Each error code directly relates to an error_text result listed below:
0,1,5,7,11,27,999

Integer

error_text

Expect one of the following:

• Live (0)
• Dead (1)
• Inconclusive (5)
• Insufficient Credit (7)
• No Teleservice Provisioned (11)
• Absent Subscriber (27)
• Number Not Supported (999)

String

status

Expect: Delivered ,Undelivered or Rejected

String

mccmnc

The MCC and MNC identify the Mobile Country Code and Mobile Network Code

String

is_ported

Will indicate if the number has been ported from it's Original Network to a different Current Network

Boolean

is_roaming

Will indicate if the number is currently roaming outside of it's home location

Boolean

Tip

An error code of 0, an error text of Live and a status of Delivered all mean the number is live and contactable.

Absent Subscriber

There are three ways your number could be returned as Absent Subscriber:

  1. A prolonged period of inactivity.
  2. If a phone is turned off / Airplane mode and a call is made to that number. The HLR database will be updated to Absent Subscriber until a successful call has been made.
  3. The number has been allocated to a SIM card that has not yet been used and therefore never connected.