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.

Batch Response Parameters

The following is a list of all the parameters provided in your batch results. This is what you will see in every column when you download your results CSV.

Default Columns

These are the default headers you will see in your results file. If you don't edit any of the headers expect to see the following in this order.

Parameter
Result
Info

MSISDN

The number sent to the HLR for checking.

Status

Expect: Delivered, Undelivered or Rejected.

Error Code

Expect one of the following:

0,1,5,7,11,27,999

Each Error Code directly relates to an Error Text result listed below.

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)

A more detailed description can be found on the Error Text Descriptions page.

Error Text Descriptions

Original Network

The name of the originating network.

Current Network

The name of the network the number currently belongs to.

Only supplied on Live numbers.

Current Country

Home country of the Current Network for this number.

Only supplied on Live numbers.

Roaming Country

The name of the country the number is roaming in.

Only supplied on Live Roaming numbers.

Type

For numbers prefixed with "1"
Expect:
• Landline / Mobile / Pager/ VoIP or Unknown
All other country codes expect:
• Mobile

Date Checked

The time and date the number was checked.

Optional Columns

You can add the following fields to your results files from your Account Settings. Scroll to the .CSV generation section to add or remove the fields you require.

Parameter
Result
Info

Valid Number

Expect TRUE or Blank

This will only be populated with true if the number sent for checking is a valid number.

Original Country

Country of the Original Network for this number.

Original Country Code

The Country Code of the location of the Original Network.

You can get details of Country Codes by using our Coverage Checker page.

MCCMNC

The MCC and MNC identify the Mobile Country Code and Mobile
Network Code and relates to the Current Network of the number.

For Live numbers the current MCCMNC will be given.
For Absent Subscribers / Dead / No Teleservice Provisioned and Inconclusive results the MCCMNC of the Original network will be given.

Is Ported

Expect TRUE or FALSE.

Not currently available. You can determine if a number has been ported by comparing the Original Network and the Current Network.

Current Country Code

The country code of the location of the Current Network.

Only supplied on Live numbers.

Is Roaming

Expect TRUE or FALSE. Indicates if the number is currently roaming outside of it's home location.

Not available for every country or network.

Roaming Network

The network name that the number is currently roaming on.

Not currently available.

Roaming Country Code

The country code of the location of the roaming network.

Not currently available.

Roaming Network Prefix

The prefix of the network the number is roaming on.

Not currently available.

Hint

Batch parameters are editable from your Account Settings. Pick and choose the parameters you want to see in your results .CSV

You can also change the names of all your headers if you want and change the order they are displayed.