Response Fields - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

A request to the Address Geocode Service produces a list of geocoded results. Each result contains only the fields applicable to that match. Some fields may be omitted if they are not relevant or cannot be determined from the input.

Below table lists the response fields returned:

Response Element Type Description
addressId String Address Id in the request.
formattedAddress String All components of the address, formatted to the country's standard, on one line.
formattedStreetAddress String Street portion of the address, including the directional and street suffix, formatted to the country's standard.
formattedLocationAddress String Location portion of the address, formatted to the country's standard.

"NEW YORK, NY 10032-3725"

addressNumber String House or building number.

"10" or "630"

admin1 AdminField Specifies the largest geographic area, typically a state or province.

"longName": "New York",

"shortName": "NY"

admin2 AdminField Specifies the secondary geographic area, typically a county or district.

"longName": "RENSSELAER COUNTY",

"shortName": "RENSSELAER COUNTY"

borough AdminField Unit of local government or other administrative subdivision.

"Vazira" or "Manhattan"

building String A roofed and walled structure built for permanent use.
city AdminField Specifies a city or town name.

"longName": "TROY",

"shortName": "TROY"

country CountryField Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).
floor String Each level within a building.
neighborhood AdminField Specifies a city subdivision or locality.

""

placeName String If applicable, indicates the name of the candidate's place or building.

"PRIME MINISTER& FIRST LORD OF THE TREASURY"

postalCode String Main postal code.

"80125"

Note: Canadian postal codes are formatted using the standard 3 + 3 character structure. This ensures consistency with Canada Post guidelines and provides uniform formatting across all Canadian address outputs.
postalCodeExt String Secondary postal code, if one exists. For example, in the US, a ZIP+4 is 80125-8012.

"8012"

Note: Canadian postal codes are formatted using the standard 3 + 3 character structure. This ensures consistency with Canada Post guidelines and provides uniform formatting across all Canadian address outputs.
room String A single room within a building.
street String Street name only (no directional or street suffix).

"FRASER RIVER"

suburb AdminField Mixed-use or residential area within commuting distance of a city or urban area.

""

unit String The unit number, such as "3B".
unitType String A group or suite of rooms within a building that are under common ownership or tenancy, typically having a common entrance. (APT, STE, FLAT, etc.).
score Integer Provides a number from 0-100 to indicate how much the input was changed in order to match to the output candidate. It looks at certain fields including the house and unit numbers, street name, directional, and type, as well as postcode and area name fields. A score of 100 means that all the input fields checked exactly matched the output candidate. Available for all countries and the calculation is consistent from one country to another.
addressLines <String> array Displays multiple formatted lines to support the postal standard of a given country.
"PRIME MINISTER& FIRST LORD OF THE TREASURY",
                                "10 DOWNING STREET",
                                "LONDON",
                                "SW1A 2AA",
                                "UNITED KINGDOM"
location Location

Describes the location type and coordinates.

Location Description: BUILDING, BUILDING_CENTROID, ROOM, ROOM_CENTROID, UNIT, UNIT_CENTROID, PARCEL, PARCEL_CENTROID, ENTRANCE, CENTER_LINE_PROJECTED, POI, IOT_DEVICE, SEGMENT_CENTER, UNKNOWN

Location Type: ADDRESS_POINT, ADDRESS_INTERPOLATED, INTERSECTION, NEAR_BY_ADDRESS, STREET_CENTER, STREET_BLOCK, POSTAL_CENTROID, NEIGHBORHOOD_CENTROID, CITY_CENTROID, ADMIN2_CENTROID, ADMIN1_CENTROID, COUNTRY_CENTROID, NO_LOCATION, UNKNOWN

Location Designation: Placement of the location.

For example, when the location type is STREET or CITY, designation returns CENTROID.

additionalMetadata: Any additional metadata about the location
explanation Explanation

Describes the level of matching for each component of an address.

MatchType: Level of match occurred

ADDRESS, STREET, ADMIN, POBOX, POI*, NOMATCH, UNKNOWN

*To return POI values, configure a dataset that contains points of interest (POI) data

MatchDescription: Indicates the level of matching.

EXACT or NONE
customFields Object

Returns additional information about the address; see Custom Output fields below for more details.
explanation Explanation Describes the level of matching for each component of an address.