Input 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

Input fields are the parameters required in an API request. They define how the service processes data and what information is returned. Input fields fall into two categories:

  • Preferences: Configuration options that control the behavior of the API (e.g., result limits, locale, fallback modes).
  • Address Fields: Address fields represent the actual content provided to the Geocode API for processing. These fields supply the core information that the service evaluates, validates, or transforms to return geocoding results. They typically include structured address components such as street, city, postal code, and country, along with optional metadata for more precise matching.
Table 1.
Field Name Type Required Description Sample Value
addressId String Optional Unique identifier for the address record. 1
addressLines Array Required Full address string provided as one or more lines. 1700 District Ave #300 Burlington, MA
country String Required Country name or ISO country code where the address is located. USA
addressNumber String Optional Street number or building number. 1700
admin1 String Optional First‑level administrative division (e.g., state or province). MA
admin2 String Optional Second‑level administrative division (e.g., county). Middlesex
city String Optional City or locality name. Burlington
borough String Optional Borough or district within a city. Manhattan
neighborhood String Optional Neighborhood name. Downtown
suburb String Optional Suburb or smaller locality. North Burlington
postalCode String Optional Postal or ZIP code. 01803
postalCodeExt String Optional Extended postal code (ZIP+4 in the U.S.). 1234
placeName String Optional Landmark or place name. Mall Road Plaza
street String Optional Street name component of the address. District Ave
building String Optional Building name or identifier. Corporate Center
floor String Optional Floor number within a building. 3
room String Optional Room number within a building. 305
unit String Optional Apartment or unit number. 12B
unitType String Optional Type of unit (e.g., apartment, suite). Suite