Bulk Geo Addressing Service: Verify - 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

  • URL Composition
    • Base URL: https://api.cloud.precisely.com
    • API Path: /v2/bulk/verify
    • API Path: /v1/bulk/verify
  • Rate Limit (Transactions per minute): 5

Input Fields

The below table lists the input fields for Address Verify Service:

Parameter Type Description
address String Requested address, based on the country's addressing standard.

10 downing street London SW1A 2AA
addressid String AddressId for the request.

1
addressLines2 String Requested address line 2, based on the country's addressing standard.

Single-line request:

"10 downing street london SW1A 2AA"
addressLines3 String Additional Requested address details, based on the country's addressing standard.

Single-line request:

"10 downing street london SW1A 2AA"
city String Specifies a city or town name.

New York City
country String Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).

USA
postalCode String Main postal code.

"80125"
state String Specifies the state name

New York

Output Fields

Below table lists the output fields returned:

Response Element Type Description
addressId String AddressId for the request.

1
addressNumber String House or building number.

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

"New York" or "Maharashtra".

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

"Douglas County" or "West Mumbai".
block String the block number.
city AdminField Specifies a city or town name.

"New York City"
country CountryField Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).
county String The county FIPS code. 25017
crsName Object

The coordinate reference system (CRS) used for the candidate's geocode. Expressed in epsg:nnnn

format;

epsg:4326

errorMessage String

The error messagereturned from the service with an error code.
formattedAddress String All components of the address, formatted to the country's standard, on one line.
"PRIME MINISTER& FIRST LORD OF THE TREASURY, 10 DOWNING STREET, LONDON, SW1A 2AA"

or "630 168TH ST, NEW YORK NY 10032-3725"
formattedLocationAddress String Location portion of the address, formatted to the country's standard.

"LONDON SW1A 2AA" or "NEW YORK, NY 10032-3725"
formattedStreetAddress String Street portion of the address, including the directional and street suffix, formatted to the country's standard.

"10 DOWNING STREET" or "630 W 168TH ST"
fromWorldFallBack    
geoHash String

Uses the latitude and longitude of the geocoded candidate to return a 32-bit

encoded string representing an area.
gnafAddressClass String The Address_Class is constructed using a combination of elements from the G-NAF Data Dictionary source tables. The components of the Address_Class field are:

A Alias address record

P Principal address record

PP Principal primary address record

PS Principal secondary address record

AP Alias primary address record

AS Alias secondary address record
gnafConfidence String A number indicating how many G-NAF datasets the address is found in. A higher confidence level means that the same address was found in more data contributor sources.
gnafGeocodeLevel String A number indicating the level o f geocode for the address. Every principal address within the G-NAF database has at least a locality level geocode. They may also have a street level geocode and a point level geocode.
gnafParcelId String The Parcel ID field is the generic parcel id field provided by custodial data, and represents a Lot on Plan description that is useful for government agencies. The exact format varies. G-NAF source data has over 7 million records with a Parcel_ID.
gnafPid String The G-NAF Persistent Identifier (G-NAF PID) is a 14-character alphanumeric string that uniquely identifies each G-NAF address. The PID is constructed from a combination of the major address fields of the G-NAF database.
gnafReliability String A number indicating the geocode precision. Reliability is related to the dictionary used to determine the geocode. Data with geocoded reliability levels 1, 2, and 3 is contained in the GNAF123 Dictionary. This is point (parcel) level geocoded data. Data with geocoded reliability levels 4, 5, and 6 is contained in the GNAF456 Dictionary. This contains non-parcel centroid geocoded data.
inputAddressLines <String> array Specifies Address Lines provided by the user. 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"
inputAddressNumber String Specifies House or building number provoided by the user.

"10" or "630"
inputAdmin1 AdminField Specifies the admin1 value provided by the user. Typically a state or province.

"New York" or "Maharashtra".

InputAdmin2 AdminField Specifies the secondary geographic area details provided by the user.

"Douglas County" or "West Mumbai".
inputBorough AdminField Specifies the Borough value provided by the user. Unit of local government or other administrative subdivision.

"Vazira" or "Manhattan"
inputBuilding String Specifies the building value provided by the user i.e. a roofed and walled structure built for permanent use.
inputCity AdminField Specifies the city or town name provided by the user.

"New York City"
InputCountry CountryField Specifies Country value provided by the user.Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).
inputFloor String Specifies the Floor value provided by the user i.e. each level within a building.
inputNeighborhood AdminField Specifies the neighborhood value provided by the user. For example City subdivision or locality.

""
inputPlaceName String Specifies the PlaceName value provided by the user. If applicable, indicates the name of the candidate's place or building.

"PRIME MINISTER& FIRST LORD OF THE TREASURY"
inputPostalCode String Specifies the PostalCode value provided by the user.

"80125"
InputPostalCodeExt String Specifies the Postal Code Ext value provided by the user. Secondary postal code, if one exists. For example, in the US, a ZIP+4 is 80125-8012.

"8012"
inputRoom String Specifies the Room value provided by the user i.e. a single room within a building.
inputStreet String Specifies the Street value provided by the user. Street name only (no directional or street suffix).

"FRASER RIVER" or "168TH"
inputSuburb AdminField Specifies the Suburb value provided by the user. Mixed-use or residential area within commuting distance of a city or urban area.

""
inputUnit String Specifies the Unit value provided by the user, for example unit number "3B".
inputUnitType String Specifies the Unit Type value provided by the user i.e. group or suite of rooms within a building that are under common ownership or tenancy, typically having a common entrance. (APT, STE, FLAT, etc.).
language object Specify the locale value.

th for the Thai language.
latitude <Number> array

The candidate's geocode, specified as y (latitude) coordinate.

-31.276491389162288

locationDescription String

locationDescription describes the description of the geometry location.

locationDesignation String locationDesignation describes the designation of the geometery location.
locationType Object

LocationType describes the Geometry location. For example, it will tell the user what

the precision of the returned Location is or how it was determined.
locCode    
longitude <Number> array

The candidate's geocode, specified as x (longitude) coordinate.

149.19290021000003

lotNum  

Lot numbers are returned for candidates because some rural addresses

do not have adequate physical or house number information.
lotNumber Integer 4-digit eLot number.
matchCode String

Match codes indicate the portions of the address that matched or did not match

to the reference file.

Shhh

pbKey String

A unique address identifier returned when an address match is made using the

Master Location Dataset (MLD).

P0000GL638OL

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

"PRIME MINISTER& FIRST LORD OF THE TREASURY"
pointId    
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"
precisionCode String A code describing the precision of the geocode.

S8HPNTSCZA
precisionLevel Integer A code describing the precision of the geocode.

1 Interpolated street address
preDirectional String Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.

NE
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.
status String Status of the response.

OK
street String Street name only (no directional or street suffix).

"FRASER RIVER" or "168TH"
throughfareType String Street type after the main address.

Main St

Bulk Verify V2 Fields

Bulk Geocode V2 expands the output schema to align with the Real-Time Geo Addressing API and provide richer, globally consistent address intelligence. V2 retains all core V1 fields but introduces new administrative, building-level, match-quality, and formatting fields. It also consolidates many legacy V1-only attributes into the customFields JSON object for better extensibility.

V1 Fields Now Only Available in customFields:

All V1‑only fields removed from V2 appear as keys inside the customFields JSON object.

Examples include thoroughfareType, matchCode, county, pbKey, geoHash, USPS DPV fields, GNAF fields, and many others.

These fields are no longer top‑level columns in V2 but remain fully accessible for workflows that depend on them.

Below table Lists the Geocode Output fields with their versions available:
Table 1.
Field Description Version
addressId Unique identifier for the processed address record. V1 & V2
status Processing status. V1 & V2
score Match score. V1 & V2
formattedAddress Fully formatted address. V1 & V2
formattedStreetAddress Formatted street-level address. V1 & V2
formattedLocationAddress Formatted locality-level address. V1 & V2
addressNumber Primary address number. V1 & V2
countryName Common name of the country. V2
country ISO alpha-3 country code. V1 & V2
countryIso2 ISO alpha-2 country code. V2
countryNumeric ISO numeric-3 country code. V2
admin1 First-level administrative area. V1 & V2
admin1Short Short name for admin1. V2
admin2 Second-level administrative area. V1 & V2
admin2Short Short name for admin2. V2
city City/locality. V1 & V2
cityShort Short name for city. V2
postalCode Postal code. V1 & V2
postalCodeExt Postal code extension. V1 & V2
placeName Place or POI name. V1 & V2
building Building name/identifier. V2
floor Floor within a building. V2
neighborhood City subdivision/locality. V2
neighborhoodShort Short name for neighborhood. V2
suburb Residential/mixed-use area. V2
suburbShort Short name for suburb. V2
borough Local government/administrative subdivision. V2
boroughShort Short name for borough. V2
room Room identifier. V2
street Street name. V1 & V2
addressLines Postal-standard formatted address lines. V2
locationType Location type. V1 & V2
locationDescription Descriptive text about the location. V1 & V2
locationDesignation Location designation/label. V1 & V2
locationFeatureType Type of location feature. V2
crsName Coordinate reference system. V1 & V2
geometryType Geometry type (always Point). V2
longitude Longitude. V1 & V2
latitude Latitude. V1 & V2
addressMatchType Match type. V2
addressMatchDescription Match quality description. V2
sourceLabel Address processor information. V2
classifications Parsed address component details. V2
inputAddressNumber Input address number. V1 & V2
inputAddressLines Input address lines. V1 & V2
inputAdmin1 Input admin1. V1 & V2
inputAdmin2 Input admin2. V1 & V2
inputCity Input city. V1 & V2
inputBorough Input borough. V1 & V2
inputNeighborhood Input neighborhood. V1 & V2
inputSuburb Input suburb. V1 & V2
inputPostalCode Input postal code. V1 & V2
inputPostalCodeExt Input postal code extension. V1 & V2
inputPlaceName Input place name. V1 & V2
inputStreet Input street. V1 & V2
inputBuilding Input building. V1 & V2
inputFloor Input floor. V1 & V2
inputRoom Input room. V1 & V2
inputUnit Input unit. V1 & V2
inputUnitType Input unit type. V1 & V2
inputCountry Input country. V1 & V2
customFields JSON object containing extended attributes. V1 & V2
unitType Unit type. V1 & V2
unit Unit identifier. V1 & V2
errorMessage Error message. V1 & V2