HLR Lookup

GET {{baseUrl}}/hlr-lookup?number=<string>&country-code=<string>

Connect to the global mobile cellular network and retrieve the status of a mobile device

Request Params

KeyDatatypeRequiredDescription
numberstring(Required) A phone number
country-codestringISO 2-letter country code, assume numbers are based in this country. <br>If not set numbers are assumed to be in international format (with or without the leading + sign)

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;number-valid&quot;:&quot;\u003cboolean\u003e&quot;,&quot;international-calling-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;mnc&quot;:&quot;\u003cstring\u003e&quot;,&quot;number-type&quot;:&quot;\u003cstring\u003e&quot;,&quot;hlr-valid&quot;:&quot;\u003cboolean\u003e&quot;,&quot;hlr-status&quot;:&quot;\u003cstring\u003e&quot;,&quot;ported-network&quot;:&quot;\u003cstring\u003e&quot;,&quot;imsi&quot;:&quot;\u003cstring\u003e&quot;,&quot;mcc&quot;:&quot;\u003cstring\u003e&quot;,&quot;international-number&quot;:&quot;\u003cstring\u003e&quot;,&quot;local-number&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;is-ported&quot;:&quot;\u003cboolean\u003e&quot;,&quot;msin&quot;:&quot;\u003cstring\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;origin-network&quot;:&quot;\u003cstring\u003e&quot;,&quot;is-mobile&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is-roaming&quot;:&quot;\u003cboolean\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code3&quot;:&quot;\u003cstring\u003e&quot;,&quot;currency-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;roaming-country-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;msc&quot;:&quot;\u003cstring\u003e&quot;,&quot;current-network&quot;:&quot;\u003cstring\u003e&quot;}