Custom Preferences: Verify Service (Addressing API) - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

Custom preferences supported by the Verify 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 - sentencecase
DPV_CMRA boolean as string Indicates whether address processor will perform CMRA processing.
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.
FINALIST_LOG_LEVEL string Set the messaging level.
  • 0 — No logging.

  • 1 — Critical messages only.

  • 2 — Error and critical messages.

  • 3 — Warning, error, and critical messages.

  • 4 — Information, warning, error, and critical messages.

  • 5 — Debugging, information, warning, error, and critical messages

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 LACSLink processing.
Note: The USPS CASS regulations require LACSLink processing. If you do not perform LACSLink 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 SuiteLink 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 (post code 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.
R777_DELIVERABLE boolean as string Determines if the address processor performs Carrier Route code R777 processing.
REMOVE_NOISE_CHARS boolean as string Determines if the address processor removes unnecessary punctuation and blanks.
OFF
All unnecessary punctuation and blanks have been removed from input data. The address processor will bypass the routine that checks each line for "noise characters" to improve performance.
ON
Input data may contain unnecessary punctuation and blanks. The address processor will perform the routine that removes noise characters.
Blank
Defaults to ON.
RESULT_CODE boolean as string Return codes describing the result of the validation processing.
RETURN_ALIAS_STREET_WITH_TYPE string Returns an alias street name with street type.
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.
RETURN_SLK_SECONDARY string Action to take when an input secondary is provided that does not match the SuiteLink returned information.
STAND_ALONE_PMB boolean as string

Pass in the Private Mailbox (PMB) information without being on the address line.

STAND_ALONE_UNIT boolean as string Pass in Unit information (e.g., apartment or flat number) without being on the address line.
VM_DATA_BLOCK boolean as string Data for National Change of Address (NCOA) processing.
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.