Query Parameters

Parameter	Description	Usage
address	Free-form address text. Note: Preferred address format: `<CITY><STATE><POSTAL CODE>+<COUNTRY>`	Required
timestamp	Specifies UTC time in milliseconds. The value is time elapsed since January 1, 1970 UTC. The input can contain negative and positive values, where the positive values express time after January 1, 1970 UTC, and negative values express time before January 1, 1970 UTC.	Required
matchMode	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. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses. 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. Use this mode if you are not confident that your input is clean; free of misspellings and incomplete addresses. 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. Interactive (USA only) Available in single-line address matching only. This mode is designed to better handle the specific matching challenges presented by interactive matching. Interactive mode permits for more flexible matching patterns and may, in some cases, return additional possible matches than relaxed match mode. CASS (USA only) Imposes additional rules to ensure compliance with the USPS CASS regulations. The purpose of this match mode is to create mailable addresses for USPS mailing discounts. Use this mode to standardize your input for mailing. This mode generates a large number of match candidates.	Optional
country	ISO country code or country name.	Optional

address

Free-form address text.

Note:

Preferred address format:

<CITY><STATE><POSTAL CODE>+<COUNTRY>

Required

timestamp

Specifies UTC time in milliseconds. The value is time elapsed since January 1, 1970 UTC. The input can contain negative and positive values, where the positive values express time after January 1, 1970 UTC, and negative values express time before January 1, 1970 UTC.

Required

matchMode

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. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses.
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. Use this mode if you are not confident that your input is clean; free of misspellings and incomplete addresses.
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.
Interactive (USA only): Available in single-line address matching only. This mode is designed to better handle the specific matching challenges presented by interactive matching. Interactive mode permits for more flexible matching patterns and may, in some cases, return additional possible matches than relaxed match mode.
CASS (USA only): Imposes additional rules to ensure compliance with the USPS CASS regulations. The purpose of this match mode is to create mailable addresses for USPS mailing discounts. Use this mode to standardize your input for mailing. This mode generates a large number of match candidates.

Optional

country

ISO country code or country name.

Optional