Sign in

v34

latestOpenAPI 3.1.0raw.githubusercontent.com2025-05-1961327.8 KB
Lookup

Look up for phone number

Perform a phone number lookup.

get/lookup/{phone_number}

Path parameters

phone_numberstring phone_number required

An E.164 formatted phone number to look up.

Query parameters

typestring[]

Optional features. Possible values are:

  • cnam - Retrieve CNAM (Caller ID Name) along with other information. Contact us if you need to use this functionality.

Headers

customer-uuidstring uuid required

Your customer UUID, which can be found in the API settings in the dashboard.

Response

OK

phone_numberstring phone_number

An E.164 formatted phone number.

mccstring

The mobile country code of the phone number.

mncstring

The mobile network code of the phone number.

caller_namestring

The CNAM (Caller ID Name) associated with the phone number. Contact us if you need to use this functionality. Once enabled, put cnam option to type query parameter.

carrierstring

The carrier of the phone number.

country_codestring

The ISO 3166-1 alpha-2 country code of the phone number.

number_portedboolean

Whether the phone number has been ported.

temporary_phone_numberboolean

Whether the phone number is in our database of disposable, temporary phone numbers

line_type'CallingCards' | 'FixedLine' | 'InternetServiceProvider' | 'LocalRate' | 'Mobile' | 'Other' | 'Pager' | 'PayPhone' | 'PremiumRate' | 'Satellite' | 'Service' | 'SharedCost' | 'ShortCodesCommercial' | 'TollFree' | 'UniversalAccess' | 'Unknown' | 'VPN' | 'VoiceMail' | 'Voip'

The type of phone line.

  • CallingCards - Numbers that are associated with providers of pre-paid domestic and international calling cards.
  • FixedLine - Landline phone numbers.
  • InternetServiceProvider - Numbers reserved for ISPs.
  • LocalRate - Numbers that can be assigned non-geographically.
  • Mobile - Mobile phone numbers.
  • Other - Other types of services.
  • Pager - Number ranges specifically allocated to paging devices.
  • PayPhone - Allocated numbers for payphone kiosks in some countries.
  • PremiumRate - Landline numbers where the calling party pays more than standard.
  • Satellite - Satellite phone numbers.
  • Service - Automated applications.
  • SharedCost - Specific landline ranges where the cost of making the call is shared between the calling and called party.
  • ShortCodesCommercial - Short codes are memorable, easy-to-use numbers, like the UK's NHS 111, often sold to businesses. Not available in all countries.
  • TollFree - Number where the called party pays for the cost of the call not the calling party.
  • UniversalAccess - Number ranges reserved for Universal Access initiatives.
  • Unknown - Unknown phone number type.
  • VPN - Numbers are used exclusively within a private telecommunications network, connecting the operator's terminals internally and not accessible via the public telephone network.
  • VoiceMail - A specific category of Interactive Voice Response (IVR) services.
  • Voip - Specific ranges for providers of VoIP services to allow incoming calls from the regular telephony network.

Example response

{
  "phone_number": "+1234567890",
  "mcc": "310",
  "mnc": "410",
  "carrier": "AT&T",
  "country_code": "US",
  "line_type": "Mobile"
}