Custom Options

The following table lists the options that are unique for USA. These custom fields are optional input parameters, and unless otherwise noted, they are available for both Geocoding and Reverse Geocoding.

Option Name Option Name
Geocode Options - Matching > Search Criteria
Search Area

These options set the search constraints to use when matching. These can assist in finding a match when the input address contains limited or inaccurate city or ZIP Code information.

Search Area
Finance Area
Searches the entire Finance Area for possible streets. Default.
Note: This option has no effect when performing a ZIP centroid match or a geographic geocode.
City
Searches the specified city.
Search Radius
Allows the setting of the search radius distance to use when matching.
Search Radius - limit to state
Allows for limiting the search to the state.
Note: Supported only in forward geocoding.
Search Radius Distance When the Search Radius option is selected, this field allows you to enter the search radius distance to use when matching. You can select either miles or kilometers. The max. radius setting is 99 miles/159 kilometers. The default radius distance is 25 meters.
Search on first letter of Street Name Specifies whether to look for the correct first letter of a street name if the first letter is missing or incorrect. If selected, GeoCode searches through the alphabet looking for the correct first letter to complete the street address. Default = disabled.
Note: This option is ignored if the match mode is set to Exact.
Note: Supported only in forward geocoding.
Check for first letter Missing/Wrong

Enables extra processing for bad first letter (missing, wrong, etc.). Default = disabled.

Note: Supported only in forward geocoding.
Geocode Options - Matching > Conflicting input
Prefer Zip over City Prefers candidates matching the input ZIP Code over matches to input city. Default = disabled.
Note: Supported only in forward geocoding.
Prefer PO Box over Street Address If both a street address and a PO Box are provided in the input address, the PO Box is used for matching. Default = disabled.
Note: This option is ignored if processing in CASS mode.
Firm name lookup Determines whether the preferred lookup is to look for only a street match, the streets first or the firms first.
Disabled
Do not use firm name matching. Default.
Match street only
Matches to the address line.
Attempt street match first
Matches to the address line, if a match is not made, then matches to the Place Name line.
Attempt firm match first
Matches to the Place Name line, if a match is not made, then matches to the address line.
Note: Supported only in forward geocoding.
Geocode Options - Matching > Find Options
Building Search on Address Line Attempts to obtain a street address when the input address contains a building name with no suite or unit number.

When this option is disabled, Geocode is able to match to building names only if there is a unit number in the input. Default = disabled.

Note: Supported only in forward geocoding.
Allow Ranged Address Numbers
Some business locations are identified by address ranges. For example, a shopping plaza could be addressed as 10-12 Front St. This is how business mail is typically addressed to such a business location. These address ranges can be geocoded to the interpolated mid-point of the range. Default = disabled.
Note: Address range matching is not supported in Exact or CASS match modes, since an address range is not an actual, mailable USPS® address.
Note: Supported only in forward geocoding.
Street Locator

Specifies whether to return a street segment geocode as an automatic geocoding fallback. Default = disabled.

Note: Supported only in forward geocoding.
Geocode Options - Geocoding
ZIP Code Centroid Level
A ZIP Code centroid match returns the center point of an area defined by one of the following types of ZIP Codes:
Any
Returns the most accurate ZIP Code centroid match found. Default.
9-Digit ZIP
Returns the center point of a ZIP + 4 Code area.
7-Digit ZIP
Returns the center point of a ZIP + 2 Code area.
5-Digit ZIP
Returns the center point of a ZIP Code area. This is the least accurate of the ZIP Code centroids.
Calculate Centerline projection of point Computes the closest point on the street from the parcel point. Default = disabled.
Note: This feature requires that a point-level Geocode dataset is installed.
Centerline Offset Centerline matching is used with point-level matching to tie a point-level geocode with its parent street segment. This functionality is useful for routing applications.

The centerline offset specifies the distance to move the point from the street centerline toward the parcel point. Default = 0 meters.

You can select either Feet or Meters for your unit of measurement.

Note: Centerline matching requires that a point-level Geocode dataset is installed.
Note: Supported only in forward geocoding.
Geocode Options - Return Values
Mixed case output address Returns candidate information in mixed case rather than uppercase. Default = mixed case.
Output corrected last line Corrects elements of the output lastline, providing a good ZIP Code or close match on the soundex even if the address would not match or was non-existent.
Note: Supported only in forward geocoding.
Reverse Geocode Options - Find Options
Find Options These options set the constraints to use when matching.
Nearest Address
Attempts to match to the nearest address. Default = enabled.
Nearest Intersection
Attempts to match to the nearest intersection match. Default = disabled.
Nearest Unranged Segment
Attempts to match to the nearest unranged segement. Default = disabled.
Prefer Match to Closest Point
Attempts to match to the nearest point address within the search radius, rather than to the closest feature (e.g. street segment or intersection as well as point addresses). Default = disabled.
Note: This feature requires that at least one points dataset and one streets dataset are loaded; otherwise, the match will be made to the closest feature.
Reverse Geocode Options - Multiple Results
Keep Multiple Matches Sets the maximum number of match candidates to be returned.
Enabled
Return all match candidates.
Disabled
Return only the best match candidate. Default.
FIND_ADDR_POINT_INTERP When set to true, uses address point interpolation. Default = false.
Note: Supported only in forward geocoding.
FIND_ADDRCODE When set to true, attempts to standardize and find an address geocode. Set this option if you want the address parsed and standardized. If this option is not set, only the input ZIP and ZIP+4 address elements are used. Default = false.
Note: Supported only in forward geocoding.
FIND_ADDRESS_RANGE When set to true, returns address range information. Default = false.
Note: Supported only in forward geocoding.
FIND_ALTERNATE_LOOKUP Determines whether the preferred lookup is to look for the streets first or the firms first. Default = 3.
Note: Supported only in forward geocoding.
1
Prefer street lookup: Matches to the address line, if a match is not made, then matches to the placeName line.
2
Prefer firm lookup: Matches to the placeName line, if a match is not made, then matches to the address line.
3
Street lookup only: Matches to the address line. Default.
FIND_BUILDING_SEARCH Controls the ability to search by building name entered in the address line. When set to true, enables matching to building names even when no unit numbers are present. Default = false.
Note: Supported only in forward geocoding.
FIND_CENTERLINE_OFFSET Offset distance from the street center for a centerline match. Any positive integer, which represents number of feet. Default = 0 feet.
Note: Supported only in forward geocoding.
FIND_CENTERLN_PROJ_OF_POINT When set to true, computes the closest point on the street from the parcel point. Default = false.
Note: Supported only in forward geocoding.
Note: This feature requires that point-level geocoding dataset is installed.
FIND_CORRECT_LASTLINE When set to true, corrects elements of the output lastline, providing a good ZIP Code or close match on the soundex even if the address would not match or was non-existent. Default = false.
Note: Supported only in forward geocoding.
FIND_DB_ORDER Allows you to specifically set the order in which GSD data sets are searched. The default search order is:
  • Point GSD files
  • Street GSD files
Enter a list of GeoCode dataset index values [starting at 0, separated by semi-colons] indicating which datasets to search and in what order.
FIND_EXPANDED_SEARCH_RADIUS Allows the setting of the radius in miles (up to 99) around which your record lies. Must be used with applicable FIND_SEARCH_AREA setting. Default radius setting = 25 miles.
FIND_EXPND_SRCH_LIM_TO_STATE When set to true, limits an expanded search to a state's border. Must be used with applicable FIND_SEARCH_AREA setting. Default = true.
FIND_FIRST_LETTER_EXPANDED When set to true, enables extra processing for bad first letter (missing, wrong, etc.). Default = false.
Note: Supported only in forward geocoding.
FIND_MIXED_CASE When set to true, returns candidate information in mixed case rather than uppercase. Default = false.
FIND_PREFER_POBOX When set to true, if both a street address and a PO Box are provided in the input address, the PO Box is used for matching. Ignored if processing in CASS mode. Default = false.
If both FIND_PREFER_POBOX and FIND_PREFER_STREET are set to true, then they are ignored, and the default, FIND_PREFER_STREET is used.
Note: Supported only in forward geocoding.
FIND_PREFER_STREET When set to true, if both a street address and a PO Box are provided in the input address, the street address is used for matching. Ignored if processing in CASS mode. Default = false.
If both FIND_PREFER_POBOX and FIND_PREFER_STREET are set to true, then they are ignored, and the default, FIND_PREFER_STREET is used.
Note: Supported only in forward geocoding.
FIND_PREFER_ZIP_OVER_CITY When set to true, prefers candidates matching input ZIP over matches to input city. Default = false.
Note: Supported only in forward geocoding.
FIND_SEARCH_AREA This option assists in finding a match when the input address contains limited or inaccurate city or ZIP Code information. One of the following options:
0
Searches the specified city.
1
Searches the entire Finance Area for possible streets. Note: This option has no effect when performing a ZIP centroid match.
2
Allows the setting of an expanded search area. When selected, you can use two other options to set how far to expand the search: FIND_EXPANDED_SEARCH_RADIUS and FIND_EXPND_SRCH_LIM_TO_STATE.
FIND_STREET_CENTROID When set to true, enables street locator geocoding. Default = true.
Note: Supported only in forward geocoding.
RETURN_LAT_LON_AS_INTEGER_VALUE When set to true, returns the LAT and LON custom fields as integer values in millionths of degrees. Default = false, returns the the LAT and LON custom fields as decimal values.