Address - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

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

AssignGeoTAXInfoPlusGTR returns the standardized or validated address in the fields listed in these tables:

Standard Address

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.

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.

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

FirmName

The validated firm or company name.

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.

Parsed Address

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.

Response Element

Description

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.

City

Validated city name

Country

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

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

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.

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.

CanadianDeliveryInstallationAreaName

Delivery installation name (Canadian addresses only)

CanadianDeliveryInstallationQualifierName

Delivery installation qualifier (Canadian addresses only)

CanadianDeliveryInstallationType

Delivery installation type (Canadian addresses only)

Address Validation Result Codes

Response Element

Description

ApartmentLabel.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. and Canadian addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. and Canadian addresses only.
R
The apartment label is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

ApartmentNumber.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. addresses that are an EWS match will have a value of P. U.S. and Canadian addresses only.
R
The apartment number is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. addresses.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

City.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
F
Hyphens missing or punctuation errors. Canadian addresses only.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output.
R
The city is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. addresses.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

Country.Result

These result codes do not apply to U.S. or Canadian addresses.

M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

FirmName.Result

C
Corrected. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. and Canadian addresses only.
U
Unmatched. U.S. and Canadian addresses only.
V
Validated. The data was confirmed correct and remained unchanged from input. U.S. addresses only.

HouseNumber.Result

A
Appended. The field was added to a blank input field. Canadian addresses only.
C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
O
Out of range. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
R
The house number is required but is missing from the input address. Canadian addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. or Canadian addresses.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

LeadingDirectional.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. Non-blank input was corrected to a non-blank value. U.S. addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input. Does not apply to Canadian addresses.

POBox.Result

A
Appended. The field was added to a blank input field. Canadian addresses only.
C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple matches. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
R
The P.O. Box number is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.
Blank
Not applicable.

PostalCode.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. Does not apply to Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Does not apply to U.S. addresses.
R
The postal code is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. or Canadian addresses.
U
Unmatched. For example, if the street name does not match the postal code, both StreetName.Result and PostalCode.Result will contain U.
V
Validated. The data was confirmed correct and remained unchanged from input.

PostalCode.Source

These result codes apply to U.S. addresses only.

FinanceNumber
The ZIP Code™ in the input was verified by using USPS® Finance Number groupings.
ZIPMOVE
The ZIP Code™ in the input address was corrected because the USPS® redrew ZIP Code™ boundaries and the address is now in a different ZIP Code™.

PostalCode.Type

P
The ZIP Code™ contains only PO Box addresses. U.S. addresses only.
U
The ZIP Code™ is a unique ZIP Code™ assigned to a specific company or location. U.S. addresses only.
M
The ZIP Code™ is for military addresses. U.S. addresses only.
null
The ZIP Code™ is a standard ZIP Code™.

RRHC.Result

C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
M
Multiple matches. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
R
The rural route/highway contract is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. U.S. and Canadian addresses only.
U
Unmatched. U.S. and Canadian addresses only.
V
Validated. The data was confirmed correct and remained unchanged from input. U.S. and Canadian addresses only.

RRHC.Type

These result codes apply to U.S. addresses only.

HC
The address is a Highway Contract address.
RR
The address is a Rural Route address.

StateProvince.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. addresses only.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output.
R
The state is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. addresses.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

StreetName.Result

A
Appended. The field was added to a blank input field. Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Does not apply to U.S. addresses.
S
Standardized. This option includes any standard abbreviations. U.S. and Canadian addresses only.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

TrailingDirectional.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. and Canadian addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

USUrbanName.Result

These result codes apply to U.S. addresses only.

A
Appended. The field was added to a blank input field.
C
Corrected.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

ApartmentLabel2.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. and Canadian addresses only. For more information, see Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. and Canadian addresses only.
R
The apartment label is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

ApartmentNumber2.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. addresses that are an EWS match will have a value of P. U.S. and Canadian addresses only.
R
The apartment number is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. addresses.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

StreetName.Alias.Type

This result code applies to U.S. addresses only.

Note: In previous releases this field was named StreetName.AliasType with no "." between "Alias" and "Type." This old name is obsolete. Please update your processes to use the new name StreetName.Alias.Type.
Abbreviated
The alias is an abbreviation of the street name. For example, HARTS-NM RD is an abbreviated alias for HARTSVILLE NEW MARLBORO RD.
Changed
There has been an official street name change and the alias reflects the new name. For example if SHINGLE BROOK RD is changed to CANNING DR, then CANNING DR would be a changed alias type.
Other
The street alias is made up of other names for the street or common abbreviations of the street.
Preferred
The street alias is the locally preferred alias. For example, a street is named "South Shore Dr." because it runs along the southern shore of a lake, not because it is south of a municipal demarcation line. So, "South" is not a predirectional in this case and should not be shorted to "S". So, "South Shore Dr." would be the preferred alias.

StreetSuffix.Result

The result codes for the street name (for example, 123 E Main St Apt 3).

Blank
Not applicable.
A
Appended. The field was added to a blank input field.
C
Corrected.
D
Dropped. The field provided on input was removed.
M
Multiple. The input address matched multiple records in the postal database. Each matching record has a different value in this field.
S
Standardized. This option includes any standard abbreviations.
V
Validated. The data was confirmed correct and remained unchanged from input.

Address Input

Response Element

Description

ApartmentLabel.Input

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

ApartmentNumber.Input

Apartment number, for example: 123 E Main St APT 3

City.Input

Validated city name

Country.Input

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

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

FirmName.Input

The validated firm or company name

HouseNumber.Input

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

LeadingDirectional.Input

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

POBox.Input

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

PostalCode.Input

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

PrivateMailbox.Input

Private mailbox indicator

PrivateMailbox.Type.Input

The type of private mailbox. Possible values include:

  • Standard
  • Non-Standard

RRHC.Input

Rural Route/Highway Contract indicator

StateProvince.Input

Validated state or province name

StreetName.Input

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

StreetSuffix.Input

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

TrailingDirectional.Input

Trailing directional, for example: 123 Pennsylvania Ave NW

USUrbanName.Input

USPS® urbanization name

CanadianDeliveryInstallationAreaName.Input

Delivery installation name (Canadian addresses only)

CanadianDeliveryInstallationQualifierName.Input

Delivery installation qualifier (Canadian addresses only)

CanadianDeliveryInstallationType.Input

Delivery installation type (Canadian addresses only)