HLR Lookup

{
  "type": "object",
  "required": [
    "country",
    "country-code",
    "country-code3",
    "currency-code",
    "current-network",
    "hlr-status",
    "hlr-valid",
    "imsi",
    "international-calling-code",
    "international-number",
    "is-mobile",
    "is-ported",
    "is-roaming",
    "local-number",
    "location",
    "mcc",
    "mnc",
    "msc",
    "msin",
    "number-type",
    "number-valid",
    "origin-network",
    "ported-network",
    "roaming-country-code"
  ],
  "properties": {
    "country": {
      "type": "string",
      "description": "The phone number country"
    },
    "country-code": {
      "type": "string",
      "description": "The number location as an ISO 2-letter country code"
    },
    "country-code3": {
      "type": "string",
      "description": "The number location as an ISO 3-letter country code"
    },
    "currency-code": {
      "type": "string",
      "description": "ISO 4217 currency code associated with the country"
    },
    "current-network": {
      "type": "string",
      "description": "The currently used network/carrier name"
    },
    "hlr-status": {
      "type": "string",
      "description": "The HLR lookup status, possible values are: <br> <ul> <li>ok - the HLR lookup was successful and the device is connected</li> <li>absent - the number was once registered but the device has been switched off or out of network range for some time</li> <li>unknown - the number is not known by the mobile network</li> <li>invalid - the number is not a valid mobile MSISDN number</li> <li>fixed-line - the number is a registered fixed-line not mobile</li> <li>voip - the number has been detected as a VOIP line</li> <li>failed - the HLR lookup has failed, we could not determine the real status of this number</li> </ul>"
    },
    "hlr-valid": {
      "type": "boolean",
      "description": "Was the HLR lookup successful. If true then this is a working and registered cell-phone or mobile device (SMS and phone calls will be delivered)"
    },
    "imsi": {
      "type": "string",
      "description": "The mobile IMSI number (International Mobile Subscriber Identity)"
    },
    "international-calling-code": {
      "type": "string",
      "description": "The international calling code"
    },
    "international-number": {
      "type": "string",
      "description": "The number represented in full international format"
    },
    "is-mobile": {
      "type": "boolean",
      "description": "True if this is a mobile number (only true with 100% certainty, if the number type is unknown this value will be false)"
    },
    "is-ported": {
      "type": "boolean",
      "description": "Has this number been ported to another network"
    },
    "is-roaming": {
      "type": "boolean",
      "description": "Is this number currently roaming from its origin country"
    },
    "local-number": {
      "type": "string",
      "description": "The number represented in local dialing format"
    },
    "location": {
      "type": "string",
      "description": "The number location. Could be a city, region or country depending on the type of number"
    },
    "mcc": {
      "type": "string",
      "description": "The mobile MCC number (Mobile Country Code)"
    },
    "mnc": {
      "type": "string",
      "description": "The mobile MNC number (Mobile Network Code)"
    },
    "msc": {
      "type": "string",
      "description": "The mobile MSC number (Mobile Switching Center)"
    },
    "msin": {
      "type": "string",
      "description": "The mobile MSIN number (Mobile Subscription Identification Number)"
    },
    "number-type": {
      "type": "string",
      "description": "The number type, possible values are: <br> <ul> <li>mobile</li> <li>fixed-line</li> <li>premium-rate</li> <li>toll-free</li> <li>voip</li> <li>unknown</li> </ul>"
    },
    "number-valid": {
      "type": "boolean",
      "description": "True if this a valid phone number"
    },
    "origin-network": {
      "type": "string",
      "description": "The origin network/carrier name"
    },
    "ported-network": {
      "type": "string",
      "description": "The ported to network/carrier name (only set if the number has been ported)"
    },
    "roaming-country-code": {
      "type": "string",
      "description": "If the number is currently roaming, the ISO 2-letter country code of the roaming in country"
    }
  }
}