Parameters for U.S. Addresses - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

Parameter

Description

Option.LatLonFormat

Specifies the format of the latitude/longitude returned by the geocoder.

Decimal
The latitude/longitude is returned in decimal format. Default. For example: 90.000000-180.000000
Integer
The latitude/longitude is returned in integer format. For example: 90000000-180000000

Option.CentroidPreference

Determines the type of centroids returned by the geocoder. A centroid is the center of an area. The centroid coordinates are the average of the sets of coordinates that describe the area.

NoCentroids
Do not return centroids. If an address-level geocode cannot be determined, do not attempt to determine a centroid.
AddressUnavailable
Return a ZIP Code centroid if an address-level geocode cannot be determined (default).
AllCentroids
Return ZIP Code centroids only. If you select this option, address-level geocodes will not be returned.

Option.FallbackToStreet

Specifies whether to attempt to return a street centroid when an address-level geocode cannot be determined. To determine a street centroid, the geocoder searches the input ZIP Code or city for the closest match. If the geocoder is able to locate the street, it returns a geocode along the matched street segment.

For example, if the input address is 5000 Walnut Street, Boulder 80301, and there is no 5000 Walnut Street, the geocoder searches for the closest match to that address within the ZIP Code 80301. If there were no input ZIP Code, the geocoder would search for the closest match to the input address within Boulder.

If the input address is Walnut Street, Boulder 80301, since there is no house number, the geocoder searches for the street within the input ZIP Code.

Street centroid geocodes are indicated by value in the LocationCode output field that begins with "C". For more information, see Street Centroid Location Codes.

Note: This option is not available if you set Option.MatchMode to CASS.
Y
Yes, attempt to determine the street centroid when an address-level geocode cannot be determined.
N
No, do not attempt to determine the street centroid when an address-level geocode cannot be determined. Default.

Option.Datum

Determines the North American Datum to use when geocoding datum on the input value. Datum is the mathematical model of the Earth used to calculate the coordinates on any map, chart, or survey system.

NAD27
This datum does not include the Alaskan Islands or Hawaii. Latitudes and longitudes that are surveyed in the NAD27 system are valid only in reference to NAD27 and are not valid for maps outside the U.S.
NAD83
This datum is earth-centered and defined with satellite and terrestrial data. NAD83 is compatible with the World Geodetic System 1984 (WGS84), which is the terrestrial reference frame associated with the NAVSTAR Global Positioning System (GPS) used extensively for navigation and surveying. Default.
Option.AddressPreference

Determines which address to use when more than one address is present in the address block.

PreferPOBox
Uses the P.O Box.
PreferBottom
Uses the second line entered. Default. You must select this value if you.
PreferStreetAddress
Uses the street address.

Option.FirstLetterSearch

Specifies whether to look for the correct first letter of a street name if the first letter is missing or incorrect. If enabled, the geocoder searches through the alphabet looking for the correct first letter to complete the street address.

Note: This option is not available if the match mode is set to Exact.
Y
Perform first letter search.
N
Do not perform first letter search. Default.

This example includes an incorrect first letter:

Input: 4750 nalnut boulder co 80301
Output: 4750 Walnut St Boulder CO 80301-2532

This example excludes a first letter:

Input: 4750 alnut boulder co 80301
Output: 4750 Walnut St Boulder CO 80301-2532

This example includes an extra first letter:

Input: 4750 wwalnut boulder co 80301
Output: 4750 Walnut St Boulder CO 80301-2532

Option.PerformDPV

Specifies whether to process addresses using Delivery Point Validation (DPV). DPV is a United States Postal Service (USPS) technology that validates the accuracy of address information down to the physical delivery point. You must have licensed the optional DPV processing option to use this feature. You must also install the DPV database.

To use DPV, enable this processing option and specify D in Option.OutputRecordType.

Y
Perform DPV.
N
Do not perform DPV. Default.

If you use DPV, multiple matches are automatically resolved.

False-positive addresses, also known as seed records, are addresses the USPS monitors to ensure users are not attempting to create a mailing list from the DPV data. If the geocoder matches an address in your input data to a false-positive address, you receive a message indicating you have encountered a false-positive address. Processing continues to the end of your job, but DPV processing is not available for this job and subsequent jobs until you have reported the false-positive address encounter to technical support and have received a new security key.

Option.PerformLACSLink

Specifies whether to process addresses using LACSLink.

Y
Perform LACSLink
N
Do not perform LACSLink. Default.

If you use LACSLink, be sure to choose to specify output record types P and Q so that the fields USLACS, USLACS.ReturnCode, and LACSADDRESS are included in the output.

For more information, see Locatable Address Conversion System (LACS).

Option.PreferZipCodeOverCity

Specifies whether to prefer candidates that match the input ZIP over candidates that match to input city.

Note: This option is not available when processing in CASS mode.
Y
Prefer candidates that match the input ZIP Code.
N
Prefer candidates that match the input city. Default.

For example, consider this input address:

301 BRYANT ST
SAN FRANCISCO CA 94301

Without this option enabled, the best match would be the one that matches the input city name:

301 BRYANT ST
SAN FRANCISCO CA 94107-4167

With this option enabled, the best match would be the one that matches the input ZIP Code:

301 BRYANT ST
PALO ALTO CA 94301-1408

Option.MatchModeUS

Determines the leniency used to find a match. One of the following:

Custom
Allows you to select the specific criteria to use when matching the input address to an address in the postal database.
Exact
Requires a very tight match. This is a restrictive mode that generates the fewest number of match candidates to search, which decreases the time to obtain a match. When using this mode, ensure that your input address list is very clean; free of misspellings and incomplete addresses.
Close
Requires a moderately confident match. Generates a moderate number of match candidates.
Relax
This is the loosest match mode and generates the most match candidates, which increases the processing time and results in more multiple matches. Use this mode if your address list may contain misspellings and incomplete addresses. This mode does not respect the street parity for an address match. Default.
Interactive
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. This mode recognizes and parses two unit numbers on the same address line, for example a building and unit number. This mode does not respect the range parity when making an address match.
Capabilities and restrictions:
  • Interactive match mode allows users to break the cardinal rule: If the user enters 123 S Main and there is only 123 N Main, a match is made and a match code is returned that reflects the modified directional.
  • Interactive match mode handles cases where users transpose pre-directionals with post-directionals without penalty.
  • Interactive match mode ignores the 'Prefer ZIP Code over city' setting. When the city and ZIP Code don't match correctly, the best geocoding result will be returned based on an analysis of all the input address elements.
  • When operating in interactive mode, in cases where a point address or interpolated street address result cannot be determined, ZIP-9 or ZIP-7 centroid(s) may be returned.
CASS
Imposes additional rules to ensure compliance with the USPS regulations for CASS. The purpose of this mode is to create a list of mailable addresses. This mode generates a large number of match candidates. This mode deviates from the other modes in its processing. This mode does not perform intersection, building name, or spatial alias (street name alias) matches. It does not match to candidates from data sources that do not have USPS equivalent records. This mode recognizes and parses two unit numbers on the same address line, for example a building and unit number.

Option.OutputCasing

Specifies the casing of the output data. One of the following:

M
Returns the output in mixed case. Default. For example:

123 Main St
Mytown FL 12345

U
Returns the output in upper case. For example:

123 MAIN ST
MYTOWN FL 12345

Option.OutputFormattedOnFail

Specifies whether to normalize addresses that fail to match, and addresses that are unchanged. Normalization formats an address to the USPS guidelines without validating the address.

Y
Perform standardization. Default.
N
Do not perform standardization.

Option.OutputPostalCodeSeparator

Specifies whether to include the dash in full postal code output.

Y
Include the dash. Default.
N
Do not include the dash.

Option.OutputVerbose

Specifies whether to provide an additional description field as output. These fields provide the text equivalent to a field represented by a code. For example, LocationCode returns a code that indicates the accuracy (quality) of the assigned geocode. LocationCode.Description provides the description for the code returned.

Y
Include verbose fields.
N
Do not include verbose fields. Default.