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. For the standard set of options available to all countries and their definitions, see the chapters covering Geocode Service and Reverse Geocode Service.

Option Name	Description
FIND_ADDR_POINT_INTERP	When set to `true`, enables address point interpolation. Default = `false`. Note: Supported only in forward geocoding. Note: This feature does not work with point addresses in Auxiliary files.
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. Note: Ignored in CASS and Exact match modes.
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. Note: Ignored in CASS match mode. `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. Note: Ignored in CASS match mode.
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. Note: This feature requires a points dataset is installed.
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 a points dataset is installed.
FIND_CLOSEST_POINT	When set to `true`, matches 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 = `false`. Note: Supported only in reverse geocoding. Note: This feature requires that at least one points dataset and one streets dataset are installed; otherwise, the match will be made to the closest feature.
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 User Dictionary and GSD data sets are searched. The default search order is: User Dictionaries Point GSD files Street GSD files Enter a list of geocoding dataset index values [starting at 0, separated by semi-colons] indicating which datasets to search and in what order.
FIND_DPV	When set to `true`, enables delivery point validation. Default = `false`. Note: Supported only in forward geocoding.
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. Note: Ignored in CASS match mode.
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`. Note: Ignored in CASS match mode.
FIND_FIRST_LETTER_EXPANDED	When set to `true`, enables extra processing for a bad first letter (missing, wrong, etc.). Default = `false`. Note: Supported only in forward geocoding. Note: Ignored in Exact match mode.
FIND_LACSLINK	When set to `true`, enables LACS^Link lookup. 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_NEAREST_ADDRESS	When set to `true`, enables matching to addresses interpolated on street segments or to point data locations. You can use FIND_NEAREST_ADDRESS and FIND_NEAREST_INTERSECTION together to specify reverse geocoding to both addresses and intersections. For reverse geocoding, you need to set the reverse geocoding processing find properties: FIND_NEAREST_ADDRESS, FIND_NEAREST_INTERSECTION, and/or FIND_NEAREST_UNRANGED. Default = `false`. Note: Supported only in reverse geocoding.
FIND_NEAREST_INTERSECTION	When set to `true`, enables matching to intersections. You can use FIND_NEAREST_INTERSECTION and FIND_NEAREST_ADDRESS together to specify reverse geocoding to both addresses and intersections. For reverse geocoding, you need to set the reverse geocoding processing find properties: FIND_NEAREST_ADDRESS, FIND_NEAREST_INTERSECTION, and/or FIND_NEAREST_UNRANGED. Default = `false`. Note: Supported only in reverse geocoding.
FIND_NEAREST_UNRANGED	When set to `true`, enables matching a street segment with no number ranges. to intersections. Enabled with FIND_NEAREST_ADDRESS. Ignored for point data and intersection matches. Note: Supported only in reverse geocoding.
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. 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. Note: Ignored in CASS match mode.
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. 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. Note: Ignored in CASS match mode.
FIND_PREFER_ZIP_OVER_CITY	When set to `true`, prefers candidates matching the input ZIP Code over matches to the input city. Default = `false`. Note: Supported only in forward geocoding. Note: Ignored in CASS and Interactive match modes. Interactive match mode attempts to return the best address regardless of this setting.
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. Note: Ignored in CASS match mode.
FIND_SEARCH_DIST	When FIND_APPROXIMATE_PBKEY is enabled, this parameter sets the distance to use when searching for the nearest address record with an associated pbKey™ unique identifier. The allowable range is 0-5280 feet. Default = 150 feet. Note: Supported only in forward geocoding.
FIND_STREET_CENTROID	When set to `true`, enables street locator geocoding. When enabled, if an input street address cannot be found using the street number and name, then the input ZIP Code or city/state is searched for the closest match. If the street is located, a geocode is returned along the matched street segment rather than the geocode for the entered ZIP Code or ZIP + 4. When using street locator geocoding, if no exact matching house number is found, a match code of either E029 (no matching range, single street segment found), or E030 (no matching range, multiple street segment) is returned. Default = `false`. Note: Supported only in forward geocoding. Note: Ignored in CASS match mode.
FIND_SUITELINK	When set to `true`, enables Suite^Link lookup. Default = `false`. Note: Supported only in forward geocoding. Note: Ignored in Exact match mode.
FIND_Z_CODE	When set to `true`, attempts to find any ZIP centroid match. Default = `true`. Note: Supported only in forward geocoding.
FIND_Z5_CODE	When set to `true`, attempts to find a ZIP centroid match (no ZIP + 4 or ZIP+2). Default = `false`. Note: Supported only in forward geocoding.
FIND_Z7_CODE	When set to `true`, attempts to find a ZIP+2 centroid match only (no ZIP+4 or ZIP). Default = `false`. Note: Supported only in forward geocoding.
FIND_Z9_CODE	When set to `true`, attempts to find a ZIP+4 centroid match only. Default = `false`. 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. Note: Supported only in forward geocoding.