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.

Table 1. Standard Address Output

Parameter

Description

AddressBlock1-AddressBlock9

The AddressBlock output fields contain a formatted version of the standardized or normalized address as it would be printed on a physical mail piece.

ValidateAddressInternational formats the address into address blocks using postal authority standards. Each line of the address is returned in a separate address block field.

There can be up to nine address block output fields: AddressBlock1 through AddressBlock9.

For example, this input address:

AddressLine1: 4200 Parliament Place

AddressLine2: Suite 600

City: Lanham

StateProvince: MD

PostalCode: 20706

Results in this address block output:

AddressBlock1: 4200 PARLIAMENT PL STE 600

AddressBlock2: LANHAM MD 20706-1882

AddressLine1-AddressLine5

If the address was validated, the nth line of the validated and standardized address.

If the address could not be validated, the nth line of the input address without any changes.

AddressQuality

A two-character code indicating the overall quality of the resulting address (for example, "V5", "C3", and more). This indicator does not consider how much the address had to change.

The first character generally indicates how the address was processed:

V - Verified without change

C - Verified with correction

G - Verified with geocoding

M - Multiple addresses matching

U - Unmatched with reference data.

The second character indicates the precision of the address:

5 - Delivery point confirmed to be a deliverable address.

4 - House number/Building Name is within valid range or known name but can't confirm 100% that premise is deliverable.

3 - Street name is valid, but the house number may not be.

2 - City exists but can't confirm the street does.

1 - State exists but can't confirm City does

0 - Can't confirm any part of the address exists.

AddressType

This field indicates a single letter code that indicates the type of address. One of the following:

F - The address was validated/corrected to the firm name.

B - The address was validated/corrected to the building name.

G -The address is a general delivery address.

H -The address was validated/corrected to the high-rise default.

L - The address is a large volume receiver.

M - The address is a military address.

P - The address was validated/corrected to PO box.

R - The address was validated/corrected to a rural route.

S - The address was validated/corrected to a street address.

U -The address type is unknown.
AddressFormat

The type of address data being returned:

F
French format (for example: 123 Rue Main)
E
English format (for example: 123 Main St)
City The validated city name.
Confidence The level of confidence assigned to the address being returned. Range is from zero (0) to 100; zero indicates failure, 100 indicates a very high level of confidence that the match results are correct. For multiple matches, the confidence level is 0. For details about how this number is calculated, see Introduction to the Validate Address Confidence Algorithm.

CouldNotValidate

If no match was found, which address component could not be validated:
  • ApartmentNumber
  • HouseNumber
  • StreetName
  • PostalCode
  • City
  • Directional
  • StreetSuffix
  • Firm
  • POBoxNumber
  • RuralRoute

Country

The country in the format determined by what you selected in OutputCountryFormat:
  • ISO Code
  • UPU Code
  • English
  • French
  • German
  • Spanish

Deliverability

An estimate of confidence that an item mailed or shipped to this address would be successfully delivered. One of the following:

5 - Item will be delivered.

4 - Very confident it is a deliverable address but postal service doesn't provide data to be 100% certain.

3 - Should be deliverable.

2 - Might be delivered.

1 - Doubt it would be delivered.

0 - Extremely unlikely to be delivered.

FirmName

The validated firm or company name.

Locality

Dependent place name that further subdivides a Locality. Examples are colonies in Mexico, Urbanisaciones in Spain.

ChangeScore

A value of 0 and 100 that reflects how much the address has changed to make it valid, excluding standardization of terms (for example: 'street' to '˜ST') and mild reformatting of terms. If the address changes too much, it is risker to use.

A value of 100 means no changes to the address were needed. 0 means the address is completely invalid.

This value is used to assist the caller to determine whether the address is safe enough to use. Exactly which value to determine whether an address is safe or not depends on the use case.

A common threshold value is 75, where 75 and above is treated as safe and below 75 is considered risky, for which, confirmation would need to be sought. Other businesses might use 85 or 60 as their threshold depending on the impact of an incorrect address to their business.
Note: This field is displayed when OutputRecordType option contains A (default).

CountryLevel

The category of address matching available. This is always "A" for U.S. and Canadian addresses. One of the following:

A
The address is in a country for which there is highly detailed postal data available. Addresses in this match level can have the following address elements validated and corrected, and added if missing from the input:
  • Postal code
  • City name
  • State/county name
  • Street address elements
  • Country name
B
The address is in a country for which there is a medium level of postal data available. Addresses in this match level can have the following address elements validated and corrected, and added if missing from the input:
  • Postal code
  • City name
  • State/county name
  • Country name
C
The address is in a country for which the postal data is least detailed. Addresses in this match level can have the following actions performed on them:
  • Validate and correct country name (cannot supply missing country name)
  • Validate the format of the postal code (cannot supply missing postal code or validate the code)

RecordType.Default

Code indicating the "default" match:

Y
The address matches a default record.
null
The address does not match a default record.

MultipleMatches

Indicates which address component had multiple matches, if multiple matches were found:
  • Firm
  • LeadingDirectional
  • PostalCode
  • StreetName
  • StreetSuffix
  • TrailingDirectional
  • Urbanization
Note: More than one component may be returned, in a comma-separated list.

PostalCode

The validated postal code for the address.

PostalCode.AddOn

The optional part of the postal code, according to the country's postal authority.

In the US, it is 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.

PostalCode.Base

The mandatory part of the postal code, according to the country's postal authority. In the US, it is the 5-digit base part of ZIP Code™. For example, in the ZIP Code™ 60655-1844, 60655 is the 5-digit base.

ProcessedBy

Which address coder processed the address:
USA
U.S. address coder
CAN
Canadian address coder
INT
International address coder

StateProvince

The validated state or province abbreviation.

Status

Reports the success or failure of the match attempt. For multiple matches, this field is "F" for all the possible matches.

When set to F, no match of any confidence was found.

Otherwise, if the field is not returned or is returned empty, a match of some confidence was found.

Status.Code

Reason for failure, if there is one. For multiple matches, all possible matches are set to MultipleMatchesFound.

Most common responses are:
  • InsufficientInputData
  • MultipleMatchesFound
  • UnableToValidate

Status.Description

Description of the problem, if there is one.
Possible Multiple Addresses Found
This value will appear if Status.Code=MultipleMatchesFound.
Address Not Found
This value will appear if Status.Code=UnableToValidate.