API Response Overview
Response Body
{
"dialcode_e164": "+16502530000",
"timezone": "America/Los_Angeles",
"timezone_short": "PDT",
"timezone_utc_offset": "-08:00",
"region": "West",
"sub_region": "Pacific",
"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,
"point_of_interest": null,
"neighborhood": null,
"clli": "SNFCCASY",
"switch_assignment_date": "2005-12-28T00:00:00.000Z",
"country": "United States",
"country_short": "US",
"postal_code": "94108",
"operating_company_name": "Twilio",
"operating_company_type": "clec",
"lata": "722",
"ocn": "8826",
"line_type": "voip",
"location_routing_number": "+14159686199",
"ported": true,
"risk_rating": "highly_likely",
"risk_level": 94,
"ported_date": null,
"dialcode_invalid": false,
"dialcode_impossible": false,
"notes": "Email us at support@icehook.com with any inquiries."
}
Response Attributes
dialcode_e164 - string
The requested dialcode after parsing and formatting in the E164 international standard.
timezone - string
Time Zone in which the phone number’s central office is located.
timezone_short - string
Time Zone in which the phone number’s central office is located.
timezone_utc_offset - string
Time Zone UTC offset.
region - string
Region of the country the number is orinally located.
sub_region - string
A more granular location within the Region.
administrative_area_level_3 - string
Third geographic adminstrative division where the local exchange associated with the phone number is located.
administrative_area_level_2 - string
Second geographic adminstrative division where the local exchange associated with the phone number is located.
administrative_area_level_1 - string
Two letter abbreviation of administrative_area_level_1 as defined by the United States Postal Service.
administrative_area_level_1_short - string
First 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.
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.
switch_assignment_date - string
The date in which the switch initially went into service.
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.
postal_code - string
Postal code 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.
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.
line_type - string
The type of phone service associted with the phone number.
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.
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.
ported - boolean
If null, status is unknown, true means ported, false means not ported.
ported_date - string
The date the number was ported.
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.
notes - string
Relevant messages sent in response.
Robocall/SPAM Risk Ratings
- risk_rating
- invalid
- risk_level: 0
- Not a valid or public phone number.
- highly_unlikely
- risk_level: 1-20
- Very unlikely to be a robocaller and is likely owned by a retail consumer.
- unlikely
- risk_level: 21-40
- Unlikely to be a robocaller but little is known.
- possible
- risk_level: 41-60
- There is no direct evidence this is a robocaller but likely belongs to a commercial entity.
- likely
- risk_level: 61-80
- This is a suspicious number but not enough solid evidence to indict.
- highly_likely
- risk_level: 81-99
- This is a number that has been credibly witnessed robocalling or spamming.
- invalid
Operating Company Types
- operating_company_type
- 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
- ipes
- 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
- cap