GET
/
lookup
/
{phone_number}

Authorizations

x-api-key
string
headerrequired

Headers

customer-uuid
string
required

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

Path Parameters

phone_number
string
required

An 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.

line_type
enum<string>

The type of phone line.

Available options:
FixedLine,
Mobile,
TollFree,
PremiumRate,
SharedCost,
Voip,
Pager,
VoiceMail,
UniversalAccess,
Service,
Unknown

Was this page helpful?

Get the status of an authenticationIntroduction