Standard Address Output - 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

Standard address output consists of four lines of the address which correspond to how the address would appear on an address label. City, state/province, postal code, and other data is also included in standard address output. Standard address output is returned for validated addresses if you set Option.OutputRecordType=A. Standard address fields are always returned for addresses that could not be validated. For non-validated addresses, the standard address output fields contain the address as it appeared in the input ("pass through" data). If you want addresses to be standardized according to postal authority standards when validation fails, specify Option.OutputFormattedOnFail=Y in your request.

Table 1. Standard Address Output

Response Element

Description

AdditionalInputData

Input data not used by the address validation process. For more information, see About Additional Input Data.

AddressLine1

If the address was validated, the first line of the validated and standardized address. If the address could not be validated, the first line of the input address without any changes.

AddressLine2

If the address was validated, the second line of the validated and standardized address. If the address could not be validated, the second line of the input address without any changes.

AddressLine3

If the address was validated, the third line of the validated and standardized address. If the address could not be validated, the third line of the input address without any changes.

AddressLine4

If the address was validated, the fourth line of the validated and standardized address. If the address could not be validated, the fourth line of the input address without any changes.

AddressLine5

For U.K. addresses only. If the address was validated, the fifth line of the validated and standardized address. If the address could not be validated, the fifth line of the input address without any changes.

City

The validated city name.

Country

The country in the format determined by what you selected in Data.OutputCountryFormat:

  • ISO Code
  • UPU Code
  • English
  • French
  • German
  • Spanish

DefaultValidPostalCode

This field is generated only for Canadian addresses.
A value of Y indicates that the record is non-correctable (VN) type. In such cases, you have the option of lowering the output Confidence score for the record. To do this, select the Switch default valid postal code confidence check-box in the Input Options. For more information, see section Canadian Address Options.
Note: For all other records, the field value is blank.

DepartmentName

For U.K. addresses only, a subdivision of a firm. For example, Engineering Department.

FirmName

The validated firm or company name.

POBoxOnlyDeliveryZone

Addresses located within a P.O. Box-only delivery zone can only receive postal delivery through the use of a P.O. Box. No other postal delivery method is available for these addresses (U.S. addresses only).
Y
P.O. Box-only ZIP Code.
N
Not a P.O. Box-only ZIP Code.

PostalCode

The validated ZIP Code™ or postal code.

PostalCode.AddOn

The 4-digit add-on part of the ZIP Code™. For example, in the ZIP Code™ 60655-1844, 1844 is the 4-digit add-on. (U.S. addresses only.)

PostalCode.Base

The 5-digit ZIP Code™; for example 20706 (U.S. addresses only).

StateProvince

The validated state/province or its abbreviated value.

USUrbanName

The validated urbanization name. (U.S. addresses only.) This is used primarily for Puerto Rico addresses.

ValidZipFlag

Y
Valid ZIP Code.
N
Invalid ZIP Code.