Address Autocomplete HTTP Response - Precisely Data Integrity Suite

Prediction Object Fields

Table 1.
Field	Type	Description
prediction	String	The full predicted address as a single formatted string.
distance.value	Number	Distance between the input location and the predicted address.
distance.distanceUnit	String	Unit of measurement for distance (e.g., "METER").
address	Object	Structured address components parsed and standardized by the service.
addressLines	Array<String>	Address formatted as multiple lines (street line, city/state/ZIP).
location	Object	Geospatial representation of the predicted address, including coordinates.
explanation	Object	Details about how the address was matched, including match types for each component.
customFields	Object	Additional metadata and Precisely-specific enrichment fields.

Address Object Fields

Table 2.
Field	Type	Description
address.formattedAddress	String	Fully formatted address (street + city + state + postal code).
address.formattedStreetAddress	String	Formatted street-level address (house number + street).
address.formattedLocationAddress	String	Formatted locality portion (city, state, postal code).
address.addressNumber	String	House or building number.
address.country.isoAlpha3Code	String	ISO-3166-1 alpha-3 country code (e.g., "USA").
address.admin1.longName	String	Full name of the first-level administrative area (state).
address.admin1.shortName	String	Abbreviation of the state (e.g., "PA").
address.admin2	Object	County or second-level administrative area (empty if not available).
address.city.longName	String	Full city name.
address.city.shortName	String	Short or standardized city name.
address.neighborhood	Object	Neighborhood information (empty if not applicable).
address.postalCode	String	Postal (ZIP) code.
address.street	String	Street name, including directional or suffix if present.

Location Object Fields

Table 3.
Field	Type	Description
location.feature.type	String	GeoJSON feature type (always "Feature").
location.feature.properties.crsName	String	Coordinate reference system (e.g., "epsg:4326").
location.feature.geometry.type	String	Geometry type (always "Point").
location.feature.geometry.coordinates	Array<Number>	Longitude and latitude of the predicted address.

Explanation Object Fields

Table 4.
Field	Type	Description
explanation.addressMatch.description	Array<Object>	List of address components and how each matched the input.
label	String	Name of the address component (e.g., "street", "postalCode").
matchType	String	Match quality: "EXACT", "PARTIAL", "NONE".
matchedSubstring	String	Portion of the input that matched (present only for partial/exact matches).
explanation.source.label	String	Indicates the data source used for the match (e.g., "ggs").

Custom Fields

Table 5.
Field	Type	Description
PB_KEY	String	Precisely unique identifier for the address record.
DISTANCE	String	Distance value as a string (may be "0" or negative zero).
FROM_CUSTOM_DATASET	String	Indicates whether the match came from a custom dataset ("true"/"false").
MATCHED_FROM_ADDRESSNUMBER	String	Address number extracted from the input.
MATCHED_FROM_STREETNAME	String	Street name extracted from the input.
ADDRESS_NUMBER_FROM	String	Parsed address number used for matching.
POSTAL_VERIFIED	String	Indicates whether the postal code was validated ("YES"/"NO").
FORMATTED_STRING	String	Fully formatted address string.
RECORD_TYPE	String	Internal record classification code.
FEATUREID	String	Unique identifier for the geospatial feature.
ZIP4	String	ZIP+4 extension (if available).
DISTANCE_UNIT	String	Unit used for distance calculations (e.g., "METERS").

Address Autocomplete API Examples:

Below is an example response for Matched Addresses:

{
  "response": {
    "status": "OK",
    "predictions": [
      {
        "prediction": "350 Jordan Ave, Montoursville, PA 17754",
        "distance": {
          "value": 0,
          "distanceUnit": "METER"
        },
        "address": {
          "formattedAddress": "350 Jordan Ave, Montoursville PA 17754",
          "formattedStreetAddress": "350 Jordan Ave",
          "formattedLocationAddress": "Montoursville, PA 17754",
          "addressNumber": "350",
          "country": {
            "isoAlpha3Code": "USA"
          },
          "admin1": {
            "longName": "PA",
            "shortName": "PA"
          },
          "admin2": {},
          "city": {
            "longName": "Montoursville",
            "shortName": "Montoursville"
          },
          "neighborhood": {},
          "postalCode": "17754",
          "street": "Jordan Ave"
        },
        "addressLines": [
          "350 Jordan Ave",
          "Montoursville PA 17754"
        ],
        "location": {
          "feature": {
            "type": "Feature",
            "properties": {
              "crsName": "epsg:4326"
            },
            "geometry": {
              "type": "Point",
              "coordinates": [
                -76.91419,
                41.246719999999996
              ]
            }
          }
        },
        "explanation": {
          "addressMatch": {
            "description": [
              {
                "label": "placeName",
                "matchType": "NONE"
              },
              {
                "label": "addressNumber",
                "matchType": "EXACT",
                "matchedSubstring": "350"
              },
              {
                "label": "admin1",
                "matchType": "NONE"
              },
              {
                "label": "admin2",
                "matchType": "NONE"
              },
              {
                "label": "city",
                "matchType": "NONE"
              },
              {
                "label": "neighborhood",
                "matchType": "NONE"
              },
              {
                "label": "suburb",
                "matchType": "NONE"
              },
              {
                "label": "street",
                "matchType": "PARTIAL",
                "matchedSubstring": "JORDAN"
              },
              {
                "label": "postalCode",
                "matchType": "NONE"
              },
              {
                "label": "streetType",
                "matchType": "NONE"
              },
              {
                "label": "postalCodeExt",
                "matchType": "NONE"
              },
              {
                "label": "streetDirectional",
                "matchType": "NONE"
              }
            ]
          },
          "source": {
            "label": "ggs"
          }
        },
        "customFields": {
          "PB_KEY": "P0000JCAW989",
          "DISTANCE": "-0.0",
          "FROM_CUSTOM_DATASET": "false",
          "MATCHED_FROM_ADDRESSNUMBER": "350",
          "MATCHED_FROM_STREETNAME": "JORDAN",
          "ADDRESS_NUMBER_FROM": "350",
          "POSTAL_VERIFIED": "YES",
          "FORMATTED_STRING": "350 Jordan Ave, Montoursville, PA 17754",
          "RECORD_TYPE": "2",
          "FEATUREID": "102759609",
          "ZIP4": "2210",
          "DISTANCE_UNIT": "METERS"
        }
      },
      {
        "prediction": "350 S Jordan Ave, San Jacinto, CA 92583",
        "distance": {
          "value": 0,
          "distanceUnit": "METER"
        },
        "address": {
          "formattedAddress": "350 S Jordan Ave, San Jacinto CA 92583",
          "formattedStreetAddress": "350 S Jordan Ave",
          "formattedLocationAddress": "San Jacinto, CA 92583",
          "addressNumber": "350",
          "country": {
            "isoAlpha3Code": "USA"
          },
          "admin1": {
            "longName": "CA",
            "shortName": "CA"
          },
          "admin2": {},
          "city": {
            "longName": "San Jacinto",
            "shortName": "San Jacinto"
          },
          "neighborhood": {},
          "postalCode": "92583",
          "street": "S Jordan Ave"
        },
        "addressLines": [
          "350 S Jordan Ave",
          "San Jacinto CA 92583"
        ],
        "location": {
          "feature": {
            "type": "Feature",
            "properties": {
              "crsName": "epsg:4326"
            },
            "geometry": {
              "type": "Point",
              "coordinates": [
                -116.95680999999999,
                33.782465
              ]
            }
          }
        },
        "explanation": {
          "addressMatch": {
            "description": [
              {
                "label": "placeName",
                "matchType": "NONE"
              },
              {
                "label": "addressNumber",
                "matchType": "EXACT",
                "matchedSubstring": "350"
              },
              {
                "label": "admin1",
                "matchType": "NONE"
              },
              {
                "label": "admin2",
                "matchType": "NONE"
              },
              {
                "label": "city",
                "matchType": "NONE"
              },
              {
                "label": "neighborhood",
                "matchType": "NONE"
              },
              {
                "label": "suburb",
                "matchType": "NONE"
              },
              {
                "label": "street",
                "matchType": "PARTIAL",
                "matchedSubstring": "JORDAN"
              },
              {
                "label": "postalCode",
                "matchType": "NONE"
              },
              {
                "label": "streetType",
                "matchType": "NONE"
              },
              {
                "label": "postalCodeExt",
                "matchType": "NONE"
              },
              {
                "label": "streetDirectional",
                "matchType": "NONE"
              }
            ]
          },
          "source": {
            "label": "ggs"
          }
        },
        "customFields": {
          "PB_KEY": "P00002SZL9FS",
          "DISTANCE": "-0.0",
          "FROM_CUSTOM_DATASET": "false",
          "MATCHED_FROM_ADDRESSNUMBER": "350",
          "MATCHED_FROM_STREETNAME": "JORDAN",
          "ADDRESS_NUMBER_FROM": "350",
          "POSTAL_VERIFIED": "YES",
          "FORMATTED_STRING": "350 S Jordan Ave, San Jacinto, CA 92583",
          "RECORD_TYPE": "2",
          "FEATUREID": "106396168",
          "ZIP4": "3512",
          "DISTANCE_UNIT": "METERS"
        }
      }
    ]
  }
}

Status Codes

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

Response	Status Code	Description
`OK`	200	The request was valid and results were found.
`Unauthorized`	401	Invalid Token
`ZERO_RESULTS`	200	The request was valid but no results were found.
`INVALID_REQUEST`	400	Invalid information was encountered in the request.
`INVALID_CLIENT_INPUT`	400	Request body or parameter format is not correct.
`INVALID_TOKEN`	401	Invalid Token was encountered.
`UNAUTHORIZED`	401	Unauthorized request encountered
`BATCH_SIZE_EXCEEDED`	413	Batch size exceeded for the request.
`INTERNAL_ERROR`	500	An internal error occurred.
`SERVICE_UNAVAILABLE`	503	Service is not available to serve the request.

Custom Output Fields

The Address Autocomplete Service can return additional Custom output fields that provide more detail about each candidate. These fields go beyond the basic address and coordinate information, offering metadata that helps you understand the accuracy, context, and usability of the result.

Not every field will be present in every response — availability depends on the input data, the dataset used, and the precision of the match.

Table 6.
Field	Type	Description
CENSUS_CD	String	The Dissemination Area (DA) 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_DA	String	The Census Division (CD) in which the address is located.
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
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 B1 LVR street C1 Government Street Address D2 LVR Served by Lock Box E2 Government Served by Lock Box F2 LVR Served by General Delivery 11 Street 21 Street served by route 32 PO Box 42 Route service 52 General delivery
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.
H3HEX	String	Hierarchical hexagonal grid value.
HIRANGE	String	House number at the high end of the range. Not applicable to street intersection matches. Only returned for US addresses. `"HIRANGE": "1700"`
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
LOWRANGE	String	House number at the low end of the range for the street segment that contains the matched address. Only returned for US addresses. `"LORANGE": "1700"`
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
parsed	ParsedAddress	parsed address elements
POST_THOROUGHFARE_TYPE	String	Street type after the main address, such as "Main St".
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 building 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
SUB_DIVISION_CODE	String	Sub-national administrative divisions code. Example: Ontario - ON
THOROUGHFARE_TYPE	String	Thoroughfare types and their common abbreviations are recognized and fully supported on input and output. For example: ROAD

Field	Type	Description
response.status	String	Indicates whether the request completed successfully. "OK" means the service returned results without errors.
response.predictions	Array<Prediction>	List of predicted address candidates returned by the service, ordered by relevance.