Authentication

HTTP Basic authentication (BA)

Parameter Overview

dialcode: e164 format

request examples

curl "https://api.scout.icehook.com/v1/numbers/search?dialcode=%2B12122226263" --basic --user [user]:[password]

curl "https://api.scout.icehook.com/v1/numbers/search" --basic --user [user]:[password] --data "{\"dialcode\":\"+12122226263\"}" --header "Content-Type:application/json"

curl "https://api.scout.icehook.com/v1/numbers/search" --basic --user [user]:[password] --data-urlencode "dialcode=+12122226263" -G

Result info

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 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.
time_zone string Time Zone associated with the phone number central office where the phone number is located.

* North America only
** US Only

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 VoiceMail
IPEX Internet Protocol Enabled Services
fixed_line Fixed Line
mobile Mobile
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

Here’s an example of the result fields returned in JSON:

{
   "timezone": America/New_York,
   "administrative_area_level_3": null,
   "administrative_area_level_2": "New York County",
   "administrative_area_level_1": "New York",
   "administrative_area_level_1_short": "NY",
   "locality": "New York",
   "sublocality_level_1": "Manhattan",
   "postal_code": "10026",
   "point_of_interest": null,
   "neighborhood": "Upper Manhattan",
   "ported: "true",
   "location_routing_number": "+16463071978"
   "clli": "NYCMNYMN",
   "country": "United States",
   "country_short": "US",
   "lata": "132",
   "ocn": "9104",
   "operating_company_name": "Verizon",
   "operating_company_type": "rboc",
   "line_type": "fixed"
}