Custom Preferences: Address Verify Service - 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

Custom preferences supported by the Verify Address Service are for use against any country dataset.

To create a custom preference for a POST request, follow this code snippet.

"preferences" : {
                "customPreferences" : {
                "<YOUR_CUSTOM_PREFERENCE>" : "<value>"
                }

Parameter	Type	Description
ADDRESS_CASING	String	Values are: `UPPER` - uppercase `LOWER` - lowercase `PROPER` - sentence case This setting determines how the response object's text is formatted. All primary fields will be formatted according to the selected option. Alphanumeric postal codes will not be changed. The Language field will always appear in lowercase. Abbreviations will always appear in uppercase. Fields that follow these exceptions will behave in the same way. Note: Custom fields are not affected by this setting.
EXTENDED_MATCH_CODE	string	Provides detailed information about all address component fields. Example of Extended Global Match Code `V4-D0M0B0U4F0G0P4S4Q0X0A0T4E0R6W0Z4Y4C4-5`
SIMPLE_MATCH_CODE	string	Focuses on the status of a subset of address component fields. Example of Simple Global Match Code `V4-P4S4A0T4R6Z4C4-5`
DPV_CMRA	boolean as string	Indicates whether address processor will perform CMRA processing.
DATA_OPTION	String	Specifies the type of data option user opts for. Following are the available values for DATA_OPTION: AddressBase Premium (default) For example: `"customPreferences": { "DATA_OPTION": "addressbase" }`
DPV_DNA	boolean as string	Indicates whether address processor uses the Door Not Accessible (DNA) Table and returns the proper DNA code.
DPV_NDD	boolean as string	Indicates Non-Delivery Days (NDD) - days which an address CANNOT receive mail.
DPV_NO_STAT	boolean as string	Indicates whether address processor uses the No-Stat Table and returns the proper No-Stat code.
DPV_NSL	boolean as string	Indicates whether address processor uses the DPV No Secure Location (NSL) Table and returns the proper NSL code.
DPV_PBSA	boolean as string	Indicates whether address processor uses the PBSA Table and returns the proper PBSA code.
DPV_THROWBACK	boolean as string	Indicates whether address processor uses the DPV Throwback Table and returns the proper Throwback code.
DPV_TIE_BREAK	boolean as string	Indicates whether to use DPV tie break processing. Note: The USPS CASS regulations require DPV Tie Break processing to generate the USPS Form 3553 (USPS CASS Summary Report).
DPV_VACANT	boolean as string	Indicates whether address processor uses the Vacant Table and returns the proper Vacant code.
EARLY_WARNING_SYSTEM	boolean as string	Indicates whether address processor will perform Early Warning System (EWS) processing.
FIND_DPV	boolean as string	Indicates whether address processor performs Delivery Point Validation (DPV) processing. Note: The USPS CASS regulations require Delivery Point Validation (DPV) processing to generate the USPS Form 3553 (USPS CASS Summary Report).
FIND_LACSLINK	boolean as string	Determines whether address processor performs LACS^Link processing. Note: The USPS CASS regulations require LACS^Link processing. If you do not perform LACS^Link processing, the address processor does not generate a USPS Form 3553 (CASS Summary Report).
FIND_RDI	boolean as string	This field indicates whether address processor will perform Residential Delivery Indicator (RDI) processing.
FIND_SUITELINK	boolean as string	Indicates whether address processor will perform Suite^Link processing.
MATCH_ON_ADDRESS_NUMBER	boolean as string	true A match must be made to the input address number. false A match does not need to be made to the input address number. Default.
MATCH_ON_ADMIN1	boolean as string	true The input `ADMIN1` must match the candidate's `ADMIN1`. False The input `ADMIN1` does not need to match the candidate's `ADMIN1`.
MATCH_ON_ADMIN2	boolean as string	true The input `ADMIN2` must match the candidate's `ADMIN2`. False The input `ADMIN2` does not need to match the candidate's `ADMIN2`.
MATCH_ON_CITY	boolean as string	true The input `CITY` must match the candidate's `CITY`. False The input `CITY` does not need to match the candidate's `CITY`.
MATCH_ON_NEIGHBORHOOD	boolean as string	true The input `NEIGHBORHOOD` must match the candidate's `NEIGHBORHOOD`. False The input `NEIGHBORHOOD` does not need to match the candidate's `NEIGHBORHOOD`.
MATCH_ON_PLACE_NAME	boolean as string	true The input `PLACE_NAME` must match the candidate's `PLACE_NAME`. False The input `PLACE_NAME` does not need to match the candidate's `PLACE_NAME`.
MATCH_ON_POSTAL_CODE	boolean as string	Indicates if the input `postCode1` field matched the candidate's `postCode1` field. true The input `postCode1` matched the candidate's `postCode1`. False The input `postCode1` did not match the candidate's `postCode1`.
MATCH_ON_POSTAL_CODE_EXT	boolean as string	Indicates if the input `postCode2` field (postcode extension) matched the candidate's `postCode2` field. true The input `postCode2` matched the candidate's `postCode2`. False The input `postCode2` did not match candidate's `postCode2`.
MATCH_ON_STREET_NAME	boolean as string	Indicates if the input street name matched the candidate's street name. true The input street name matched the candidate's street name. false The input street name did not match the candidate's street name.
RESULT_CODE	boolean as string	Return codes describing the result of the validation processing.
POST: RETURN_FORMATTED_ADDRESS	Boolean	When set to true, the Address Lines in the output will be returned in the country-specific postal format for Geocode or Verify candidates. By default, this preference is set to false. Note: Setting this preference to true has an impact on overall performance.
RETURN_INPUT_FIRM	boolean as string	This field determines whether the address processor returns the input firm. OFF Do not return the input firm. ON Return the input firm. Blank Defaults to OFF.
RETURN_PARSED_INPUT	boolean as string	The Parsed Input address displays the formatted input street address and each input address element in a separate field. This feature can help you understand how the input address was parsed by the geocoder and identify specific input elements that could not be geocoded. true Return parsed input address element. false Do not return parsed input address element. Default.
SERP_MODE	boolean as string	Enables SERP validation. SERP return codes are provided by Canada Post, indicate the quality of the input address.
VALIDATION_CONFIDENCE	boolean as string	Indicates the value of validation confidence true Returns the validation confidence value. false (Default). Does not return the validation confidence value.