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

Fields are grouped below by what they describe: number identity and validation, geography, Operating Company and network routing, number portability, and risk.

Number Identity

Fields that identify the requested dialcode and report whether it is a valid, publicly assigned NANP number.

dialcode_e164 - string

The requested dialcode after parsing and formatting in the E164 international standard.

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.

Geography

The fields in this section describe where the phone number’s local exchange is located, that is, the central office or switch that serves the number on the Operating Company’s network. They do not describe the current physical location, residence, or device location of the number’s owner.

This distinction matters most for voip and wireless line types: a subscriber can live, work, and travel far from the geographic area implied by these fields, because the values reflect the number’s network assignment rather than a live device or postal address. postal_code, point_of_interest, and neighborhood in particular can look precise enough to be mistaken for a subscriber’s mailing address; they are not. These fields are not suitable for E911 routing, legal jurisdiction determination, tax nexus, or identity or address verification.

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.

region - string

Region of the country the number’s local exchange was originally located in.

sub_region - string

A more granular location within the Region.

administrative_area_level_1 - string

First geographic administrative 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 administrative division where the local exchange associated with the phone number is located.

administrative_area_level_3 - string

Third geographic administrative 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.

neighborhood - string

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

point_of_interest - string

A point of interest in the area 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.

timezone - string

Time Zone in which the phone number’s central office is located.

timezone_short - string

Abbreviated form of the time zone in which the phone number’s central office is located.

timezone_utc_offset - string

Time Zone UTC offset.

Operating Company & Routing

Fields that identify the Operating Company serving the number and how it routes on the North American telecommunications network.

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. See Operating Company Types below for the full list of values.

ocn - string

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

line_type - string

The type of phone service associated with the phone number.

clli - string

CLLI (Common Language Location Identifier) code is an identifier used within the North American telecommunications industry to specify where the local exchange associated with the phone number is located.

lata - string

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

switch_assignment_date - string

The date on which the switch initially went into service.

Portability

Fields that report whether a number has been ported away from its original Operating Company and, if so, where it now routes.

ported - boolean

If null, status is unknown, true means ported, false means not ported.

ported_date - string

The date the number was 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 to which the phone number is now routed.

Risk

Scout’s assessment of a dialcode’s likelihood of association with robocalling or spam activity. See Risk Ratings Reference below for the full definition of each rating and its underlying score range.

risk_rating - string

Scout’s categorical assessment of a dialcode’s likelihood of association with robocalling or spam activity.

risk_level - integer

The numeric score, from 0 to 99, underlying risk_rating. Note that an invalid dialcode always returns a risk_level of 0.

Response Metadata

notes - string

Relevant messages sent in response.

Risk Ratings Reference

The table below defines each risk_rating value, its corresponding risk_level range, and what it indicates about a dialcode.

Operating Company Types