API response for any valid mobile number

Overview

Listed below are the fields you will see in an API response for any valid mobile number.

Your JSON response is broken down into four objects, the current status of the mobile number you have checked will dictate the JSON objects we will display within your result.

Issuing Information

– issuing_info:

Displayed for all valid mobile numbers

FIELD	WHAT TO EXPECT	FORMAT
verified	True - this indicates that this is a valid mobile number	Boolean
timezone	The timezone of the country where the original network is located	String
location	The country of the original network for the entered number	String
network_name	The name of the originating network	String
country_code	The country code of the location of the orginal network	Integer
area	The country of the the original network for the number entered	String

Home information

– home_info:

Displayed for all numbers reported as LIVE

ELD	WHAT TO EXPECT	FORMAT
verified	True - Indicates that this is a valid mobile number	Boolean
timezone	The timezone of the country where the original network is located	String
location	The home country of the current network for the entered number	String
network_name	The name of the current network of the entered number	String
country_code	The country code of the location of the current network	Integer
area	The country of the the current network for the number entered	String

Roaming information

– roaming_info:

Displayed when a VALID and LIVE mobile number is identified as roaming away from it’s Home Country

FIELD	WHAT TO EXPECT	FORMAT
verified	True - Indicates that the number entered is a valid mobile number	Boolean
timezone	Timezone of the country where the number is currently located	String
location	Which country the number is currently located	String
network_name	The name of the network that the SIM is currently roaming on	String
country_code	The country code of the current location of the number	Integer
area	Which country the number is currently located	String

Roaming Problems

If the results for a mobile number believed to be roaming away from its Home location do not show the number as Roaming then it is most likely Home Routing has been implemented by the Network Operator.
This means that the network will always report their numbers as being located in their Home location regardless of where they are in the world.

Status information

Status Information

These response fields indicate the current status of the number you have entered. You should use this part of the API response to determine if your numbers are Live or Dead etc.

FIELD	WHAT TO EXPECT	FORMAT
type	Mobile	String
msisdn	The number used for the HLR Lookup	String
error_code	Check the Status Information page for more details	Integer
error_text	Check the Status Information page for more details	String
status	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 its Original Network to a different Current Network	Boolean
is_roaming	Will indicate if the number is currently roaming outside of its home location	Boolean

API Response Example

Here’s an example JSON response for a successful HLR Lookup.

{
  "issueing_info": {
    "verified": true,
    "timezone": "Europe/Guernsey",
    "location": "United Kingdom",
    "network_name": "O2 (UK)",
    "country_code": 44,
    "area": "United Kingdom"
  },

  "home_info": {
    "verified": true,
    "timezone": "Europe/London",
    "location": "United Kingdom",
    "network_name": "EE Limited (T-Mobile)",
    "country_code": 44,
    "area": "United Kingdom"
  },
  "type": "Mobile",
  "msisdn": "447540822872",
  "error_code": 0,
  "error_text": "Live",
  "status": "Delivered",
  "mccmnc": "23430",
  "is_ported": true,
  "is_roaming": false
}

Valid Mobile Number Response