Address 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

This section describes how to Verify one or more addresses using the Address Verify API. You may want to try it out with a Free Trial Account.

This method will consume credits.

  • HTTP Request
    • URL Composition
      • Base URL: https://api.cloud.precisely.com
      • Verify: /v1/verify
    • Supported Methods: POST only
    • Rate Limit (Transactions per second): 700
    • Input Fields Each request to the API service requires a few parameters, all of which are listed below. All requests require a Bearer token, that can be generated using your account's key-secret. To produce a bearer token for an API request, the generated key-secret combinations are used. The generated token is valid for 3600sec (1 hour) and then it needs to be regenerated.

      The data should be encoded as a JSON array where each element in the array is a JSON object with field names identical to those in the input/output fields listed below.

      Table 1. Parameters
      Parameter Description Example Value
      preferences Options supported by the Address Verify Service which includes a variety of settings for match mode, candidates returned, fallbacks, offsets, match address elements, ranges information and more.

      maxResultss: The maximum number of candidates to return. Optional. Must be an integer value.

      Default = 1.
      addresses List of addresses to be processed.

      addressLines:

      Requested address, based on the country's addressing standard.

      Single-line request:

      "10 downing street london SW1A 2AA"

      Multi-line request:

      "10 DOWNING STREET",

      "LONDON, SW1A 2AA"
Below is a sample request with an address request to Address Verify Service:
{
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "",
      "featureSpecific": {}
    },
    "clientLocale": "",
    "clientCoordSysName": "",
    "distance": {
      "value": 150,
      "distanceUnit": "METER"
    },
    "streetOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "fallbackToGeographic": false,
    "fallbackToPostal": false,
    "matchMode": "",
    "returnOfAdditionalFields": false,
    "originXY": [],
    "customPreferences": {}
  },
  "addresses": [
    {
      "addressId": "1",
      "addressLines": [
        "1700 District Ave #300 Burlington, MA"
      ],
      "country": "USA",
      "addressNumber": "",
      "admin1": "",
      "admin2": "",
      "city": "",
      "borough": "",
      "neighborhood": "",
      "suburb": "",
      "postalCode": "",
      "postalCodeExt": "",
      "placeName": "",
      "street": "",
      "building": "",
      "floor": "",
      "room": "",
      "unit": "",
      "unitType": ""
    }
  ]
}

Preferences

Below are the preferences for Address Verify Service:

Option Type Description
clientCoordSysName String Specifies the coordinate system that you want to convert the geometry to. The format must be the European Petroleum Survey Group (EPSG) code or the SRID code. Default = EPSG:4326.
Specify the coordinate reference system in the format codespace:code.
Note: The API always returns the output coordinates in EPSG:4326, regardless of the input coordinate system.
clientLocale Object Specify the locale value. For example, specify "th" for the Thai language.
cornerOffset

Distance

 Specify the distance to offset the street end points in street-level matching. This is used to prevent addresses at street corners from being given the same geocode as the intersection. Defines the offset position of the geocoded point with respect to the corner. The default is 7 meters.
customPreferences

Object

 Use this option to pass some additional preferences to enable different functionalities. These functionalities works along with the normal preferences.
data_option String

Specifies the type of data option user opts for. Following are the available values for DATA_OPTION:

  • premium (default)
  • enterprise
  • essentials
For example:
"customPreferences": {
         "DATA_OPTION": "Enterprise"
     }
fallbackToGeographic Boolean Specifies whether to attempt to determine a geographic region centroid when an address-level geocode cannot be determined. Optional.
true
Return a geographic centroid when an address-level centroid cannot be determined. Default.
false
Do not return a geographic centroid when an address-level centroid cannot be determined.
fallbackToPostal Boolean Specifies whether to attempt to determine a post code centroid when an address-level geocode cannot be determined. Optional.
true
Return a post code centroid when an address-level centroid cannot be determined. Default.
false
Do not return a post code centroid when an address-level centroid cannot be determined.
matchMode String Match modes determine the leniency used to make a match between the input address and the reference data. Select a match mode based on the quality of your input and your desired output. The following match modes are available:
EXACT
Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases the processing time.
STANDARD
Requires a close match and generates a moderate number of match candidates. Default.
RELAXED
Allows a loose match and generates the most match candidates, which increases the processing time and results in more multiple matches.
CUSTOM
Provides the capability for you to define the matching criteria by setting MustMatch fields; however, you can only set the MustMatch fields using a POST request. For a GET request, the MustMatch default values are used. .
maxResults Integer The maximum number of candidates to return. Default = 1.
returnAllInfo Boolean Specifies whether to return all available information for each candidate.
true
Return all available information for each candidate.
false
Do not return all available information for each candidate. Default.
returnOfAdditionalFields <String> array

This lets the user control which additional fields they want to have returned if they do not want to return all info.

For example, to return the PreciselyID, use the value PB_KEY
{
  "preferences" : {
    "returnOfAdditionalFields " : ["PB_KEY"]
  }
}
streetOffset

Distance

 Specify the offset distance from the street segments to use in street-level geocoding. The offset prevents the geocode from being in the middle of a street.
type String

Indicates the geocode type to be performed.

ADDRESS
Geocode to a street address. Default.
GEOGRAPHIC
Geocode to the geographic centroid of a city or state.
POSTAL
Geocode to a postal code.

Request Parameters

The below table lists the request parameters for Address Verify Service:

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

Single-line request:

"10 downing street london SW1A 2AA"
Multi-line request:
"10 DOWNING STREET",
"LONDON, SW1A 2AA"
addressNumber String House or building number.

"10" or "630"
admin1 String The largest geographic area, is typically a state or province.

"New York" or "Maharashtra".

admin2 String The secondary geographic area, is typically a county or district.

"Douglas County" or "West Mumbai".
borough String Unit of local government or other administrative subdivisions.

"Vazira" or "Manhattan"
building String A roofed and walled structure built for permanent use.
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).
floor String Each level within a building.
neighborhood String A city subdivision or locality.

"Highlands Ranch"
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.
suburb String Mixed-use or residential areas 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.).