Endpoints
Look up for phone number
GET
/
lookup
/
{phone_number}
Authorizations
x-api-key
string
headerrequiredHeaders
customer-uuid
string
requiredYour customer UUID, which can be found in the API settings in the dashboard.
Path Parameters
phone_number
string
requiredAn E.164 formatted phone number to look up.
Response
200 - application/json
phone_number
string
An E.164 formatted phone number.
mcc
string
The mobile country code of the phone number.
mnc
string
The mobile network code of the phone number.
carrier
string
The carrier of the phone number.
country_code
string
The ISO 3166-1 alpha-2 country code of the phone number.
number_ported
boolean
Whether the phone number has been ported.
temporary_phone_number
boolean
Whether the phone number is in our database of disposable, temporary phone numbers
line_type
enum<string>
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.
Available options:
CallingCards
, FixedLine
, InternetServiceProvider
, LocalRate
, Mobile
, Other
, Pager
, PayPhone
, PremiumRate
, Satellite
, Service
, SharedCost
, ShortCodesCommercial
, TollFree
, UniversalAccess
, Unknown
, VPN
, VoiceMail
, Voip
Was this page helpful?