Service Objects (Preview)

Indicates if the service found one or more results or if it encountered an error when processing the query.

Indicates the number of locations found for the query that will be listed in LocationInfo array Locations. The default maximum number of location returned by the service is 10; however, a lower value can be set in the 'MaxResults' input.

Comma-separated list of descriptive note codes about the query.

Comma-separated list of descriptions that correspond to the Notes output.

Comma-separated list of warning codes about the query.

Comma-separated list of descriptions that correspond to the Warnings output.

Contains a list of LocationInfo objects.

Indicates how precise the coordinates are. Levels range from 1 - 16. The higher the number the higher the precision.

Indicates what type of location the coordinates are for. For example, the location may be for an address, thoroughfare, locality or postal code.

The latitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

The longitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

The number associated with the property. Also known as the Address, Street or House number.

The name of the thoroughfare. Also known as a street, road, highway, etc.

The name of the double dependent locality.

The name of the dependent locality.

The preferred English name of the locality, such as a City, Town or other type of Municipality.

The name of the fourth level administrative division, such as a Ward or Quarter.

The abbreviated name of the quaternary administrative area.

The name of the third level administrative division, such as a Borough or District.

The abbreviated name of the tertiary administrative area.

The name of the secondary administrative division, such as a County or Region.

The abbreviated name of the secondary administrative area.

The name of the primary administrative division, such as a State, Region, Province, County, Territory or Prefecture.

The abbreviated name of the primary administrative area.

The postal code of the international address.

The country.

The 2-letter country abbreviation.

The 3-letter country abbreviation.

Bing Maps URL with the coordinates to the location.

Google Maps URL with the coordinates to the location.

Map Quest URL with the coordinates to the location.

The name of the place that the coordinates are associated with. Most commonly the name of a municipality, city, town, village or community.

Indicates if the coordinates are for an unincorporated area. Only appears for street level property matches (S).

State FIPS (Federal Information Processing Standard) code; used to uniquely identity states.

County FIPS (Federal Information Processing Standard) code; used to uniquely identify counties across the US.

The census tract of the given address. A census tract is a statistical subdivision of a county.

The census block of the given address.A block is the smallest geographic unit used by the US Census.

A Census based geographic identification code that uniquely identifies a geographic statistical area.

A code that defines the current class of the geographic US location.

The congressional district number.

Current state legislative district upper (senate) chamber code.

Current state legislative district lower (house) chamber code

The time zone in UTC offset format.

Type

TypeCode

Desc

DescCode

Debug

Indicates if the service found one or more results or if it encountered an error when processing the query.

Indicates the number of locations found for the query that will be listed in LocationInfo array Locations. The default maximum number of location returned by the service is 10

Comma-separated list of descriptive note codes about the query.

Comma-separated list of descriptions that correspond to the Notes output.

Comma-separated list of warning codes about the query.

Comma-separated list of descriptions that correspond to the Warnings output.

Contains a list of LocationInfo objects.

Indicates how precise the coordinates are. Levels range from 1 - 16. The higher the number the higher the precision.

Indicates what type of location the coordinates are for. For example, the location may be for an address, thoroughfare, locality or postal code.

The latitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

The longitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

The number associated with the property. Also known as the Address, Street or House number.

The name of the thoroughfare. Also known as a street, road, highway, etc.

The name of the double dependent locality.

The name of the dependent locality

The preferred English name of the locality, such as a City, Town or other type of Municipality.

The name of the fourth level administrative division, such as a Ward or Quarter.

The abbreviated name of the quaternary administrative area.

The name of the third level administrative division, such as a Borough or District.

The abbreviated name of the tertiary administrative area.

The name of the secondary administrative division, such as a County or Region.

The abbreviated name of the secondary administrative area.

The name of the primary administrative division, such as a State, Region, Province, County, Territory or Prefecture.

The abbreviated name of the primary administrative area.

The postal code of the international address.

The country.

The 2-letter country abbreviation.

The 3-letter country abbreviation.

Bing Maps URL with the coordinates to the location.

Google Maps URL with the coordinates to the location.

Map Quest URL with the coordinates to the location.

The name of the place that the coordinates are associated with. Most commonly the name of a municipality, city, town, village or community.

Indicates if the coordinates are for an unincorporated area. Only appears for street level property matches (S).

State FIPS (Federal Information Processing Standard) code; used to uniquely identity states.

County FIPS (Federal Information Processing Standard) code; used to uniquely identify counties across the US.

The census tract of the given address. A census tract is a statistical subdivision of a county.

The census block of the given address.A block is the smallest geographic unit used by the US Census.

A Census based geographic identification code that uniquely identifies a geographic statistical area.

A code that defines the current class of the geographic US location.

The congressional district number.

Current state legislative district upper (senate) chamber code.

Current state legislative district lower (house) chamber code.

The time zone in UTC offset format.

Type

TypeCode

Desc

DescCode

Debug

Indicates the validity of the input address. Unless an error is returned this field will always be returned.

Indicates the level of accuracy to which the input address could be resolved.

The formatted Address 1 line of the input address.

The formatted Address 2 line of the input address.

The formatted Address 3 line of the input address.

The formatted Address 4 line of the input address.

The formatted Address 5 line of the input address.

The formatted Address 6 line of the input address.

The formatted Address 7 line of the input address.

The formatted Address 8 line of the input address.

The preferred English name of the locality, such as a City, Town or other type of Municipality. Can also be an AdministrativeArea.

The preferred English name of the administrative division of the country, such as a State, Region, Province, County, Territory or Prefecture.

Represents the standardized postal code.

The preferred english name of the country. This field will always be returned unless an error is returned.

Represents the ISO 3166-1 Alpha-2 Country Code. This field will always be returned unless an error is returned.

Represents the ISO 3166-1 Alpha-3 Country Code. This field will always be returned unless an error is returned.

An array of key value pairs that contain additional fields and information not defined in the original output schema of the API.

Name

Value

Type

TypeCode

Desc

DescCode

Debug

The corrected address candidates.

The corrected address line 1.

The corrected address line 2.

The corrected city name.

The corrected state name.

The corrected zip code + 4.

Indicates if the address is for a residence.

Number that correlates to a DPV(Delivery Point Validation) result. An indicator displaying whether or not the address is recognized as deliverable by the USPS

Explains DPV result.

DPVNoNumber that correlates to DPV notes description. Service Objects may add or change Note descriptions, but will never modify existing codes.tes

Details about the DPV result. Service Objects may add or change Note descriptions, but will never modify existing codes.

Number that correlates to a Corrections Description. Service Objects may add or change Correction descriptions, but will never modify existing codes.

Description of what was corrected in an address. Service Objects may add or change Correction descriptions, but will never modify existing codes.

The post office delivery barcode digits

4 chars: 1 for the route type, 3 for the route code. Identifies a group of addresses when prepended by 5-digit Zip.

The congress code is the congressional district number.

The county code of the given address.

The name of the county in which the given address lies.

The parsed house number of the given address.

The parsed pre-directional of the address's street.

The parsed name of the streen in the given address.

The parsed suffix of the street in the given address

The parsed post-directional of teh address's street.

The parsed unit type (e.g. 'Apt' or 'Ste')

The parsed 'Fragment' box, apartment or unit number.

The parsd type of the apartment, box, unit, etc.

The parsed apartment, box, unit, etc number of the given address.

Type

TypeCode

Desc

DescCode

Indicates if the unaltered input address is CASS certified. See “What is CASS?” below for more information.

Desc

Location

Number

Rating of how accurate the outputs are likely to be.

The city location of the IP address.

The state location of the IP address.

The country location of the IP address.

The 3-letter country abbreviation.

The 2-letter country abbreviation.

The US postal code of the IP address.

The numerical metropolitan code for the DMA of the IP address' location.

The Designated Market Area for the location of the IP address.

The state Federal Information Processing Standards code for the IP address. This code is used to uniquely identify states.

The County Federal Information Processing Standards code for the location of the IP address. This code is used to uniquely identify counties throughout the US.

The latitude coordinate for the IP address.

The longitude coordinate for the IP address.

Indicates whether the IP address is a known proxy.

Indicates the type of proxy.

Indicates if the IP address is believed to be used by mobile devices.

The ISP which assigns the IP address.

The network owner to which the IP address is allocated

The host name associated with the IP address. If more than one host name is found then the names will be returned a comma delimited list. Will return if no host names are found.

Displays additional notes about the IP that were found during the validation process. Returns zero or more numerical note codes in a comma-separated list.

Contains the note flag(s) that corresponds to the Notes Codes. Returns zero or more notes flags in a comma-separated list.

Debug

A value that represents the overall certainty that the service provided on the lead. This value will range from 0 to 100.

A field indicating whether the lead should be rejected, reviewed or accepted.

Indicates the classification that the service made for the lead.

The country associated with the lead, given as an ISO 2.

Enumerated list of descriptive notes.

Descriptions that correspond to the NoteCodes section.

Score between 0 and 100 that indicates the probability that the given name is valid.

A field indicating whether the given name should be rejected, reviewed or accepted.

The first name of the lead without diacritic characters.

The last name of the lead without diacritic characters.

The first name with diacritic characters.

The last name with diacritic characters.

Enumerated list of codes indicating further information about the name field.

Enumerated list of descriptive notes that correspond to the NameNoteCodes field.

Score between 0 and 100 that indicates the validity of the given address.

A field indicating whether the given address should be rejected, reviewed or accepted.

The resolution of the address.

The validated Address line 1.

The validated Address line 2.

The validated Address line 3.

The validated Address line 4.

The validated Address line 5.

The locality associated with the given input address. Usually corresponds to the city.

The Admin Area tied with the input address. Usually corresponds to the State or Province.

The Postal Code tied to the given input address.

2 Character ISO code for the country.

Enumerated list of codes indicating additional information about the given address.

Enumerated list of descriptive notes that are associated with the AddressNoteCodes field.

Score between 0 and 100 that indicates the validity of a given email address

A field indicating whether the given email address should be rejected, reviewed or accepted.

The email used for testing including any corrections that were made.

Enumerated list of codes indicating additional information about the given email address.

List of descriptions associated with the EmailNoteCodes field.

Score between 0 and 100 that indicates the validity of a given IP address.

A field indicating whether the given IP address should be rejected, reviewed or accepted.

The locality associated with the given IP address.

Administrative area associated with the given IP address.

Country ISO 2 code associated with the given IP address.

Enumerated list of codes indicating additional information about the given IP address.

Descriptions associated with the IPNoteCodes that indicate additional information about a given IP address.

Score between 0 and 100 that indicates the validity of the phone number in the Phone1 field.

A field indicating whether the Phone1 input should be rejected, reviewed or accepted.

Locality associated with the given phone number.

The administrative area associated with the given phone number.

The Country ISO 2 code associated with the given phone number in the Phone1 field.

Enumerated list of codes indicating additional information about the given phone 1.

Descriptions that correlate with the codes given in the Note Codes field.

Score between 0 and 100 that indicates the validity of the number given in the Phone2 field.

A field indicating whether the Phone2 input should be rejected, reviewed or accepted.

Locality associated with the given Phone Number.

The administrative area associated with the given phone number.

The Country ISO 2 code associated with the given phone number in the Phone2 field.

Enumerated list of codes indicating additional information about the given phone 2.

Descriptions that correlate with the codes given in the Note Codes field.

The contact's full name.

The contact's postal address.

The city of the contact's postal address.

The state of the contact's postal address.

The zip code of the contact's postal address.

The contacts phone type.

Score between 0 and 100 that indicates the validity of the BusinessName.

A field indicating whether the Business Name input should be rejected, reviewed or accepted.

The provided business name.

The website domain associated with the business.

The business email.

Enumerated list of codes indicating additional information about the given Business Name.

Descriptions that correlate with the codes given in the note codes field.

An array of key value pairs that contain additional fields and information not defined in the original output schema of the API.

Name

Value

Type

TypeCode

Desc

DescCode

DEBUG

The phone number that was provided as input.

The country code of the provided phone number.

The provided phone number in a national format.

The parsed extension from the provided phone number.

The locality from where the phone number belongs. The locality format is generally Locale/Region, Region or Country.

The match level that was determined from the locality that was found. Possible values include (Locale/Region, Region, Country) match.

The Time Zone of the validated phone number.

The latitude of the locality determined from the phone number.

The longitude of the locality determined from the phone number.

The country to which the validated phone number belongs.

The ISO 2 character country designation for a validated phone number.

The ISO 3 character country designation for a validated phone number.

The provided phone number in international format.

The provided phone number in E.164 format.

the carrier determined for the phone number.

The linetype determined for the phone number. See InternationalExchangeInfo LineType table below.

The SMS gateway address for the provided mobile number.

The MMS gateway address for the provided mobile number.

A boolean response type determining whether the phone number is a valid phone number.

A boolean response type determining whether the phone number is a valid phone number for the provided Country.

The corresponding codes which match NoteDescriptions. These values vary from 1 to 6 based on test results.

The corresponding descriptions which match NoteCodes. These values vary based on NoteCodes.

Type

TypeCode

Desc

DescCode

Debug