Standard Address Output - Spectrum_OnDemand - addressing - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

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 OutputRecordType=A. Standard address output is returned for validated addresses if you set Option.OutputRecordType=A. Standard address output is returned for validated addresses if you select the Include a standard address check box. 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 OutputFormattedOnFail=Y in your request. If you want addresses to be standardized according to postal authority standards when validation fails, specify Option.OutputFormattedOnFail=Y in your request. If you want addresses to be standardized according to postal authority standards when validation fails, select the Include normalized data when no match is found check box.

Table 1. Standard Address Output

Field Name

columnName

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.

AddressBlock1-6

AddressBlock1-6

If the address was validated, the address line fields contain the validated and standardized address lines. If the address could not be validated, the address line fields contain the input address without any changes.
Note: The last line of the address is contained in the LastLine field.

See the example below.

AddressLine1: 4200 PARLIAMENT PL STE 600
LastLine: LANHAM MD 20706-1882

City

The validated city name.

Country

The country in the format determined by what you selected in Country format OutputCountryFormat 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.

[Since the field is currently UK only this does not apply] A subdivision of a country used in French and Spanish speaking countries. For example, France is divided into 100 departments.

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.

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.

PBKey

The PBKey identifier for the address.

The PBKey may be empty even when the address is valid according to USPS rules as the address deliverable via USPS, such as PO Box, but not have a specific physical location.