Parsed Address Elements 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

Output addresses are formatted in the parsed address format if you set Option.OutputRecordType=E. If you want formatted data in the Parsed Address format to be returned when validation fails (that is, a normalized address), specify Option.OutputFormattedOnFail=Y.

Note: If you always want parsed input data returned regardless of whether or not validation is successful, specify Option.OutputRecordType=I. For more information, see Parsed Input.
Table 1. Parsed Address Output

Response Element

Description

AdditionalInputData

Input data not used by ValidateAddress. For more information, see Additional Input Data.

AdditionalInputData.Base

Input data that was not output to the standardized address by ValidateAddress. For more information, see Additional Input Data.

AdditionalInputData.Unmatched

Input data passed to the matcher but not used by ValidateAddress for validation. For more information, see Additional Input Data.

ApartmentLabel

Apartment designator (such as STE or APT), for example: 123 E Main St APT 3

ApartmentLabel2

Secondary apartment designator, for example: 123 E Main St APT 3, 4th Floor

Note: In this release, this field will always be blank.

ApartmentNumber

Apartment number. For example: 123 E Main St APT 3

ApartmentNumber2

Secondary apartment number. For example: 123 E Main St APT 3, 4th Floor

Note: In this release, this field will always be blank.

CanadianDeliveryInstallationAreaName

Delivery installation name (Canadian addresses only)

CanadianDeliveryInstallationQualifierName

Delivery installation qualifier (Canadian addresses only)

CanadianDeliveryInstallationType

Delivery installation type (Canadian addresses only)

City

Validated city name

Country

Country. Format is determined by what you selected in Data.OutputCountryFormat:

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

DepartmentName

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

FirmName

The validated firm or company name

HouseNumber

House number, for example: 123 E Main St Apt 3

LeadingDirectional

Leading directional, for example: 123 E Main St Apt 3

POBox

Post office box number. If the address is a rural route address, the rural route box number will appear here.

PostalCode

Validated postal code. For U.S. addresses, this is the ZIP Code.

PrivateMailbox

Private mailbox indicator.

PrivateMailbox.Type

The type of private mailbox. Possible values include:

  • Standard
  • Non-Standard
Note: This replaces PrivateMailboxType (no period in field name). Please modify your API calls accordingly.

RRHC

Rural Route/Highway Contract indicator

StateProvince

Validated state or province name

StreetName

Street name, for example: 123 E Main St Apt 3

StreetSuffix

Street suffix, for example: 123 E Main St Apt 3

TrailingDirectional

Trailing directional, for example: 123 Pennsylvania Ave NW

USUrbanName

USPSĀ® urbanization name. Puerto Rican addresses only.