Authentication

HTTP Basic authentication (BA)

Parameter Overview

dialcode: e164 format

request examples

curl -XGET https://lookups.twilio.com/v1/PhoneNumbers/+16502530000/?AddOns=icehook_scout -u AC0xxxxxxxxxxxxx:[AuthToken]

{
   "timezone": America/New_York,
   "administrative_area_level_3": null,
   "administrative_area_level_2": "San Francisco County",
   "administrative_area_level_1": "California",
   "administrative_area_level_1_short": "CA",
   "locality": "San Francisco",
   "sublocality_level_1": null,
   "postal_code": "94108",
   "point_of_interest": null,
   "neighborhood": null,
   "ported: true,
   "location_routing_number": "+14159686199"
   "clli": "SNFCCASY",
   "country": "United States",
   "country_short": "US",
   "lata": "722",
   "ocn": "8826",
   "operating_company_name": "Twilio",
   "operating_company_type": "clec",
   "line_type": "voip",
   "risk_rating": "highly_likely",
   "risk_level": "94",
   "dialcode_invalid": false,
   "dialcode_impossible": false,
}

Result Fields

Response Key

Type

Description

country

string

Name of country where the local exchange associated with the phone number is located.

country_short

string

Two letter country code (ISO 3166-1 alpha-2 format) where the local exchange associated with the phone number is located.

country_code

string

80 Telephone dialing prefix for the member countries of the International Telecommunication Union (Spec: ITU-T E.164) where the local exchange associated with the phone number is located.

administrative_area_level_1

string

First geographic adminstrative division where the local exchange associated with the phone number is located.

administrative_area_level_1_short

string

Two letter abbreviation of administrative_area_level_1 as defined by the United States Postal Service.

administrative_area_level_2

string

Second geographic adminstrative division where the local exchange associated with the phone number is located.

administrative_area_level_3

string

Third geographic adminstrative division where the local exchange associated with the phone number is located.

locality

string

The locality where the local exchange associated with the phone number is located. Typically the city name.

sublocality_level_1

string

The sublocality where the local exchange associated with the phone number is located. Boro of Brooklyn, for example.

point_of_interest

string

A point of interest in the area where the local exchange associated with the phone number is located.

neighborhood

string

The neighborhood where the local exchange associated with the phone number is located.

postal_code

string

Postal code where the local exchange associated with the phone number is located.

ported

boolean

If null, status is unknown, 'yes' means ported, 'no' means not ported.

location_routing_number**

string

If ported, a Location Routing Number (or LRN) is a unique number that uses the format of a telephone number, which represents the local exchange in which the phone number is located.

lata*

string

Local Access and Transport Area (LATA) represents a geographical area of the United States.

ocn*

string

Operating Company Number (OCN) is a 4 character ID for North American phone companies.

clli*

string

CLLI code (sometimes referred to as COMMON LANGUAGE Location Identifier Code and often pronounced as silly) is a Common Language Information Services identifier used within the North American telecommunications industry to specify the where the local exchange associated with the phone number is located.

operating_company_name*

string

The company that provides service for the phone number.

operating_company_type*

string

The type of operating company associated with the phone number.

line_type*

string

The type of phone service associted with the phone number.

time_zone*

string

Time Zone associated with the phone number central office where the phone number is located.

risk_rating*

string

The likelihood a number is associated with a robo-call


risk_level*

integer

The likelihood a number is associated with a robo-call on a scale of 0 to 99. Note that an invalid number will return a risk_level of 0.

dialcode_invalid

boolean

A number that matches the NANP format, but contains an NPA that does not exist

dialcode_impossible

boolean

A number that does not match the NANP format.

*North America Only
**
US Only



Operating Company Types Operating Company Types

Result

Description

cap

Competitive Access Provider

clec

Competitive Local Exchange Carrier

ethx

Ethernet Exchange Provider

general

Various miscellaneous cases

ic

Interexchange Carrier

ico

Independent Company

ilec

Incumbent Local Exchange Carrier

intl

International

ipex

Internet Protocol Enabled Services

l reseller

Local Reseller

p reseller

Personal Communication Services Reseller

pcs

Personal Communications Services

rboc

Regional Bell Operating Company

ulec

Unbundled Local Exchange Carrier

unknown

Unknown entity

wireless

Wireless Provider

w reseller

Wireless Reseller



Line Types

Result

Description

premium_rate

Premium Rate

toll_free

Toll Free

shared_cost

Shared Cost

voip

VoIP

personal_number

Personal Number

pager

Pager

uan

UAN

voicemail

Voice Mail

IPEX

Internet Protocol Enabled Services

fixed_line

Fixed Line

fixed_or_mobile

Fixed Line or Mobile (if both mobile and fixed pattern matches)

short_code

Short Code

emergency

Emergency

carrier_specific

Carrier Specific

sms_services

SMS services

expanded_emergency

Expanded Emergency

no_international_dialing

No International Dialing

carrier_services

Carrier Services

directory_services

Directory Services

standard_rate

Standard Rate

carrier_selection_codes

Carrier Selection Codes

area_code_optional

Area Code Optional



Risk Rating

Result

Description

highly_unlikely

Contains no known markers of a robo-call

unlikely

Contains at least one known marker of a robo-call

possible

Contains at least three known markers of a robo-call

likely

Contains at least five known markers of a robo-call

highly_likely

Contains more than seven known markers of a robo-call