Address Reverse Geocode HTTP Response - 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

Within the Addressing REST API, a request to the Address Reverse Geocode Service returns a list of results. Not every field will be returned with a result.

Below are the Response fields returned:

Field Type Description
errorMessage String Error message: The error message returned from the service with an error code.
status Status Status of the response.
results <Result array List of results based on the specified criteria.

Response Fields

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"

Note: Short names can be alphanumeric, numeric, or alphabetic.
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"
postalCodeExt String Secondary postal code, if one exists. For example, in the US, a ZIP+4 is 80125-8012.

"8012"
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.

Custom Output fields

Below table lists the custom output fields returned:
Table 1. Custom Output Fields
Field Type Description
GEOHASH String Uses the latitude and longitude of the geocoded candidate to return a 32-bit encoded string representing an area. The more characters in the string, the more precise the location. By default, the precision level is set to the highest precision of 12 characters. If another level is needed, set the custom preference GEOHASH_LEVEL.
IS_MUP String Indicates whether the property is a multi-unit property.

"IS_MUP": "true"

The following countries support multi-unit properties

  • United Kingdom (GBR)
  • Australia (AUS)
  • New Zealand (NZL)
  • Canada (CAN)
LANGUAGE String The language supported. Example Value: en
MAIN_ADDRESS String Street Address
MATCH_TYPE String

MatchType: Reflects the currently configured match type.

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

*To return POI values, configure a dataset that contains points of interest (POI) data
PRE_THOROUGHFARE_TYPE String Street type before the main address, such as Via Veneto.
PRECISION_CODE String A code that describes the precision of the address match for the input address. Example value: S8HPNTSCZA. Refer Sheet "Result_Code" for details
PRECISION_LEVEL Integer

A code describing the precision of the geocode. One of the following:

0 No coordinate information is available for this candidate address. USA addresses return 0.

1 Interpolated street address.

2 Street segment midpoint.

3 Postal code 1 centroid.

4 Partial postal code 2 centroid.

5 Postal code 2 centroid.

6 Intersection.

7 Point of interest. (If database contains POI data.)

8 State/province centroid.

9 County centroid.

10 City centroid.

11 Locality centroid.

12-15 Reserved for unspecified custom items.

16 The result is an address point.

17 The result was generated by using address point data to modify the candidate's segment data.

18 The result is an address point that was projected using the centerline offset feature. You must have both a point and a street range database to use the centerline offset feature.

19 Inside a buildling structure.
RESULT_CODE String A code that describes the precision of the address match for the input address. Example value: S8HPNTSCZA.Refer Sheet "Result_Code" for details
SECONDARY_STREET String Secondary Street Name
SEGMENT_ID String Street segment identifier
THOROUGHFARE_TYPE String Thoroughfare types and their common abbreviations are recognized and fully supported on input and output. For example: ROAD
parsed ParsedAddress parsed address elements
H3HEX String Hierarchical hexagonal grid value.
CENSUS_DA String The Census Division (CD) in which the address is located.
CENSUS_CMA String The Census Metropolitan Area (CMA) in which the address is located.
CENSUS_CSD String The Census Subdivision (CSD) in which the address is located.
CENSUS_CT String The Census Tract (CT) in which the address is located.
CENSUS_CD String The Dissemination Area (DA) in which the address is located.
CPC_RECORD_TYPE String Canadian postal code (CPC) record type. Note: returned only when the candidate contains a full postcode of FSA (Forward Sortation Area) + LDU (Local Delivery Unit). <blank> no address match was found *: Unknown A1: High-rise building B1: LVR (Large Volume Receiver) street C1: Government Street Address D2: LVR (Large Volume Receiver) Served by Lock Box E2: Government Served by Lock Box F2: LVR (Large Volume Receiver) Served by General Delivery 11: Street 21: Street served by route 32: PO Box
CPC_BUILDING_TYPE Integer when Return All Information is set to true and the type is known. Note: CPC fields are not present when SYNTHETIC_LDU = true or t. 1: Residential building 2: Commercial building
POST_THOROUGHFARE_TYPE String Street type after the main address, such as "Main St".
SUB_DIVISION_CODE String Sub-national administrative divisions code. Example: Ontario - ON

Status Codes

Each response to a request contains an HTTP status code. The Geocode Address Service will return one of the following status codes:

Response Status Code Description
OK 200 Address(es) geocoded successfully.
Unauthorized 401 Invalid Token
INVALID_REQUEST 400 Invalid information was encountered in the request.

errorMessage: Not able to identify ABC country (DIS-LI-1016)
Unauthorized: INVALID_TOKEN 401 Invalid Token was encountered.

errorMessage: Invalid token (DIS-LI-1013)
Too many Requests 429 Too many Requests
UNAUTHORIZED 401 Unauthorized request encountered
INTERNAL_ERROR 500 An internal error occurred.

errorMessage: Issue with internal services. Please try again after sometime (DIS-LI-1012)
SERVICE_UNAVAILABLE 503 Service is not available to serve the request.

errorMessage: Issue with internal services. Please try again after sometime (DIS-LI-1011)