Mobile Phone Lookup

Endpoint: https://rest.virtualincentives.com/{version}/{format}/phone/{phonenumber}/program/{programid}

Method: GET

πŸ“˜

This endpoint requires approval prior to access. Please contact your Virtual Incentives Client Success Manager to discuss your use case.

Definitions

FieldTypeDescription
phonenumberintegerMobile phone number used for the lookup. The number must be supplied as digits only and should include the country code and area code.

Example: 18001234567
programidintegerThe programid serves an identifier that determines the funding account to use for this request.
country_codeintegerMobile phone number country of origin. This is the 2-character country code (ISO 3166-2).
carrierobjectThe telecom company that provides the phone number.
mobile_country_code.carrierstringThe three digit mobile country code of the carrier, used with the mobile network code to identify a mobile network operator.
mobile_network_code.carrierstringThe two-three digit mobile network code of the carrier, used with the mobile country code to identify a mobile network operator (only returned for mobile numbers).
name.carrierstringString indicating the name of the telecom company that provides the phone number.
caller_classificationstringString indicating whether this caller is a business, consumer, or undetermined.
line_typestringThe phone number type. Possible values are landline, mobile, or nonFixedVoip.

Examples

Response XML

<lookup>
  <phone>16467361908</phone>
  <country_code>US</country_code>
  <carrier>
    <mobile_country_code>310</mobile_country_code>
    <mobile_network_code>030</mobile_network_code>
    <name>AT&T WIRELESS</name>
  </carrier>
  <caller_classication>CONSUMER</caller_classication>
  <line_type>mobile</line_type>
</lookup>

Response JSON

{
  "lookup": {
    "phone": "16467361908",
    "country_code": "US",
    "carrier": {
      "mobile_country_code": "310",
      "mobile_network_code": "030",
      "name": "AT&T WIRELESS"
    },
    "caller_classication": "CONSUMER",
    "line_type": "mobile"
  }
}