Output

Spectrum Global Address Validation output is determined by the output options you select.

Standard Address Output

Standard address output consists of address lines which correspond to how the address would appear on an address label. City, state or province, postal code, and other data are also included in the standard address output.

Table 1. Standard Address Output
Field Name Format Description
AdditionalInputData String Additional input data entered that was not used for matching.
AddressBlock1-2 String The AddressBlock output fields contain a formatted version of the standardized or normalized address as it would be printed on a physical mailpiece. Global Address Validation 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 two address block output fields: AddressBlock1 and AddressBlock2.

AddressBlock1 includes:

  • PO Box—CAN, FRA, GBR
  • Firm Name
  • Unit Number
  • Unit Type
  • House Number
  • Street Name

AddressBlock2 includes:

  • Locality
  • Town
  • Postal Code
  • County
  • State

For example, this input address:

AddressLine1: 34 Glenview Road
City: Mount Kurning-Gai StateProvince: NSW PostalCode: 2080

Results in this address block output:

AddressBlock1: 34 Glenview Road
AddressBlock2: Mount Kurning-Gai NSW 2080

In this example, the input address includes a PO Box (CAN, FRA, and GBR) and the "Prefer PO Box over street" option is selected:

AddressLine1: 1 Great Lawn PO Box 10916 CM5 5AL

Results in this address block output:

AddressBlock1: PO Box 10916
AddressBlock2: ONGAR CM5 5AL

AddressBlock3-10 String Additional AddressBlock fields for USA addresses. For USA addresses, starting from AddressBlock1 the data includes:
  • Firm Name
  • URB name
  • Extra address line information
  • Required address line information
  • Last line
AddressLine1 String The first address line.

For example, 34 GLENVIEW ROAD MOUNT KURNING-GAI NSW 2080.

In an example of a dual address, the address PO BOX 3220 STN C 181 QUEEN STREET OTTAWA ON K1Y1E4 contains both a PO Box and a street address.

If the option "Prefer PO Box over street" is enabled, PO BOX 3220 STN C displays in this field.

If the option "Prefer PO Box over street" is not enabled, 181 QUEEN STREET displays in this field.

Global Address Validation supports PO Box matching for these countries:

  • Canada (CAN)
  • France (FRA)
  • United Kingdom (GBR)
  • United States (USA)
AddressLine2 String The second address line (USA only).
ApartmentLabel String The flat or unit type. For example, 39 Acacia Avenue Flat B.
ApartmentNumber String The flat or unit number. For example, 39 Acacia Avenue Flat B.
Building String The name of a building.
City String The city or town name. Your input address should use the official city name to produce the best match results.
City.Matched String The status of the city match.
True
Matched on the city name.
False
Did not match on the city name.
CitySubdivision String The name of one of the following depending on the country:
  • Not used—AUS, AUT, BEL, CHE, DEU, DNK, FIN, FRA, IRL, MYS, NLD, NOR, POL, SWE
  • Dissemination Area and Enumeration Area (DA and EA)—CAN
  • Locality—BRA, GBR, GRC, ITA, ESP
  • Suburb—NZL
  • Urbanization name (Puerto Rico)—USA
CitySubdivision.Matched String The status of the match on city subdivision.
True
Matched on the city subdivision.
False
Did not match on the city subdivision.
Confidence String 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.
Country String The country in the language or code specified in the Country format option. For a list of ISO codes, see ISO Country Codes and Coder Support.
Country specific fields String The country specific output information. To include the country specific output information in the output, check the Country specific fields output option.
FirmName String The name of a company.
Firmname.Matched String The status of the match on firm name.
True
Matched on the firm name.
False
Did not match on the firm name.
HouseNumber String The house number or PO Box number (CAN, FRA, UK). For example, 39 Acacia Avenue or PO Box 3220.
Housenumber.Matched String The status of the match on house number.
True
Matched on the house number.
False
Did not match on the house number.
LeadingDirectional String The leading directional. For example, 123 E Main St Apt 3.
MatchOnAllStreetFields String The status of the match on all street fields.
True
Matched on all street fields.
False
Did not match on all street fields.
MatchOnStreetDirectional String The status of the match on street directional.
True
Matched on the street directional.
False
Did not match on the street directional.
MatchScore String Reserved for future use.
MultimatchCount String If the address was matched to multiple candidate addresses in the reference data, this field contains the number of candidate matches found.
PostalCode String The postal code for the address. The format of the postal code varies by country.
PostalCode.AddOn String The second part of a postal code. This field is not used by most countries.
Postalcode.Matched String The status of the match on postal code.
True
Matched on the postal code.
False
Did not match on the postal code.
Principality String An area within a country. For example, England, Scotland, and Wales are principalities. This field will normally be blank.
ProcessedBy String The Spectrum Global Addressing Management stage name.
Result Code String The field-level result codes. Field-level result codes describe how each address element was processed. Field-level result codes are returned in the qualifier "Result". For example, the field-level result code for City is contained in City.Result. For a complete listing of result code output fields, see Result Codes.
StateProvince String The name of one of the state or province depending on the country:
  • Not used—BEL, CHE, DNK, IRL, NLD, NOR
  • Bundesland—DEU
  • Province—CAN
  • Province (voivodship)—POL
  • Region—AUT, ESP, FRA, GBR, GRC, NZL
  • Region (län)—FIN
  • Region (lan)—SWE
  • State—AUS, BRA, USA
  • State (negeri)—MYS
StateProvince.Matched String The status of the match on state or province.
True
Matched on the state or province.
False
Did not match on the state or province.
StateProvinceSubdivision String The name of the state or province subdivision depending on the country.
  • Not used—AUT, BRA, CAN, FIN, GBR, MYS
  • County—USA
  • Department—FRA
  • District—GRC
  • District (fylke/counties)—NOR
  • District (poviat)—POL
  • Kommun—SWE
  • Kreis—DEU
  • Local Government Authority (LGA)—AUS
  • Province—BEL, CHE, DNK, ESP, IRL, ITA, NLD
  • Region—NZL
StateProvinceSubdivision.Matched String The status of the match on state or province subdivision.
True
Matched on the state or province subdivision.
False
Did not match on the state or province subdivision.
StreetName String The name of street where the property is located or "PO Box" to indicate the input record matched to a PO Box. For example, 123 E Main St or PO Box 3220.
StreetName.Matched String The status of the match on street name.
True
Matched on the street name.
False
Did not match on the street name.
StreetType String The street type. For example, 123 E Main St Apt 3. In another example, 123 E Main Ave Apt 3. These are two entirely different entities. Using street types adds precision to your data.
StreetType.Matched String The status of the match on street type.
True
Matched on the street type.
False
Did not match on the street type.
TrailingDirectional String The trailing directional. For example, 123 Pennsylvania Ave NW.
VendorCode String The vendor code. This field is only available if you select the output option "Country specific fields".

Parsed Input

Spectrum Global Address Validation output can include the input address in parsed form. This type of output is referred to as "parsed input." Parsed input fields contain the address data that was used as input regardless of whether or not Spectrum Global Address Validation validated the address. This information is not available when the address is validated at the postal / city level. It is available when an address gets validated at the street level. To include parsed input fields in the output, select the Parsed address output option.

Table 2. Parsed Input
Field Name Format Description
DualAddressParsed.Input String A dual address is an address that contains more than one mailable address. For example, an address that contains both a PO Box and a street address is considered a dual address. When a dual address line is entered as input, this field contains the address line that is not used for AddressBlock1.

If a PO Box (CAN, FRA, and UK) and a street address are entered as input and the option "Prefer PO Box over street" is enabled, the PO Box number is returned in the AddressLine1 field and AddressBlock1 fields and the street address is returned in the DualAddressParsed.Input field.

If a PO Box (CAN, FRA, and UK) and a street address are entered as input and the option "Prefer PO Box over street" is not enabled, the street address is returned in the AddressLine1 field and AddressBlock1 fields and the PO Box is returned in the DualAddressParsed.Input field.

ParsedAddressLine1.Input String The first address line passed on input.

For some countries (CAN, FRA, and UK), when the "PO Box over street" option is activated, this field contains PO Box.

ParsedApartmentLabel.Input String The unit designator passed on input.
ParsedApartmentNumber.Input String The unit number passed on input.
ParsedCity.Input String The city/locality/suburb name passed on input.
ParsedCitySubdivision.Input String The urbanization name passed on input.
ParsedCountry.Input String The country passed on input.
ParsedHouseNumber.Input String The house number passed on input. For example, 123 E Main St Apt 3.
ParsedPlaceName.Input String The place or firm name passed on input.
ParsedPostCodeAddOn.Input String The second part of a postal code passed on input. This field is not used by most countries.
ParsedPostCodeBase.Input String The postal code passed on input.

For some countries, this field contains the first part of the postal code and the ParsedPostCodeAddOn.Input contains the second part of the postal code.

ParsedPostStreetType.Input String The street type passed on input. For example, 123 E Main St Apt 3.
ParsedPreStreetType.Input String The predirectional type passed on input. For example, 123 E Main St Apt 3.
ParsedStateProvince.Input String The name of one of the state or province depending on the country passed on input.
ParsedStateProvinceSubdivision.Input String The subdivision passed on input.

Precision

Spectrum Global Address Validation output can include the precision code that describes the precision of the address match for the input address. To include the precision code in the output, select the Precision output option.
Note: The "Precision code counts" section on the Match Analysis Report only displays when you check the "Precision" output option.
Table 3. Precision
Field Name Format Description
PrecisionCode String A code describing the precision of the address match.

The matches in the Z category indicate that a match was made at the postal code level.

Z1
Match to ZIP Code™ or postal code 1.
Z2
Match to ZIP + 2 or partial match to postal code 2.
Z3
Match to ZIP + 4® or postal code 2.

The matches in the G category indicate that the record was matched to an area name.

G1
Match to state/province (area name 1).
G2
Match to country/region (area name 2).
G3
Match to city/town (area name 3).
G4
Match to suburb/village (area name 4).

The matches in the B category indicate that the record was matched to a PO Box.

B1
Matched to an unvalidated PO Box. Although there is enough information in the record to identify this as a PO Box, not enough information exists to determine whether the PO Box number is valid.
B2
Matched to a validated PO Box.

The matches in the S category indicate that the record was matched to a single address candidate.

S0
Single match; however, no coordinates are available. This is a very rare occurrence. Parts of the address may have matched the source data.
S1
Single match to a ZIP Code™ or postal code 1 level. This is the same quality match as a Z1 result.
S2
Single match to a ZIP + 2 or partial match to postal code 2 level. This is the same quality match as a Z2 result.
S3
Single match to a ZIP + 4® or postal code 2 level. This is the same quality match as a Z3 result.
S4
Single match at the street level.
S5
Single match to the street address. Because only the street segment data is available, the interpolation is not as accurate as an S7 return. The S5 code is followed by letters and dashes indicating match precision.
S6
Single match to a point located at a ZIP centroid.
S7
Single match to a street address that was interpolated between houses.
S8
Single match to the street address or house number.
SC
Single match at the house-level that has been projected from the nearest segment.
SG
Single match with point at the center of a locality (areaName3) or Locality level geocode derived from topographic feature. An SG result code is associated with GNAF Reliability Level 5 (locality or neighborhood) or with Level 6 (unique region). (Australia addresses only.)
SL
Single match to a sublocality (block or sector) street level match. An SL result code also requires a match on other geographic input fields (city, district, or state). (India addresses only.)
SX
Single match to a point located at a street intersection.

For S (street matched) precision codes, eight additional characters describe how closely the address matches an address in the database. The characters appear in the order shown.

For example, the result code S5--N-SCZA represents a single match that matched the street name, street suffix direction, town, and postal code. The dashes indicate that there was no match on house number, street prefix direction, or thoroughfare type. The match came from the Street Range Address database. This record would be matched at the street address level of the match candidate.

H
House number match.
P
Street prefix (pre-directional). P is present if any of these conditions are satisfied:
  • The candidate pre-directional matches the input pre-directional.
  • The candidate post-directional matches the input pre-directional after pre- and post-directionals are swapped.
  • The input does not have a pre-directional.
N
Street name match.
T
Street/thoroughfare type match.
S
Street suffix (post-directional).
  • The candidate post-directional matches the input post-directional.
  • The candidate pre-directional matches the input post-directional after pre- and post-directionals are swapped.
  • The input does not have a post-directional.
C
City or town name.
Z
Postal code match.
A
Addressing dataset match.
U
Custom user dictionary match.

Single Match 'S' Precision Codes

The following table shows the support for the S category precision codes by country. For more information on the 'S' precision codes, see Table 3. These descriptions apply to the vast majority of the countries. The exceptions for Australia and Canada are described in the sections that follow this table.

A bullet "•" indicates the S code is supported. A blank cell indicates the S code is not supported.

Country Name S8 S7 S6 S5 S4 S3 S2 S1 S0 SX SC SG SL

Australia (AUS)

Canada (CAN)

Denmark (DNK)

Germany (DEU)

Great Britain

(GBR)

India (IND)

New Zealand (NZL)

All other countries

Australia — 'S' Precision Code Descriptions

The following table provides 'S' precision code descriptions for Australia.

Result Code Description
Street level geocoded candidates return a result code beginning with the letter S. The second character in the code indicates the positional accuracy of the resulting point for the geocoded record.
S8 Single match, point located at either the single point associated with an address point candidate or at an address point candidate that shares the same house number. No interpolation is required.
S8.......G The S8.......G result code is used for single matches with GNAF Reliability levels of 1or 2 (the highest level of GNAF Reliability.
S7 Single match, located at an interpolated point along the candidate’s street segment. When the potential candidate is not an address point candidate and there are no exact house number matches among other address point candidates, the S7 result is returned using address point interpolation.
S7.......G The S7.......G result code is used for single matches with GNAF Reliability level of 3.
S5 Single match, point located at a street address position.
S4 Single match, point located at the center of a shape point path (shape points define the shape of the street polyline).
S4.......G The S4.......G result code is used for single matches with a GNAF Reliability level of 4 (associated with a unique road feature).
S0 Single match, however, no coordinates are available (this is a very rare occurrence).
SX Single match with the point located at street intersection.
SC Single match where the original point has been moved a specified distance (usually along a perpendicular line) toward or away from the associated street segment. This result code can be returned only when both a point geocoding dataset and a street segment geocoding dataset are available and when the centerline offset feature is used.
SG Single match with point at the center of a locality (areaName3) or Locality level geocode derived from topographic feature. An SG result code is associated with GNAF Reliability Level 5 (locality or neighborhood) or with Level 6 (unique region).

Canada — 'S' Precision Code Descriptions

The following table provides 'S' precision code descriptions for Canada.

Result Code Description
Street level geocoded candidates return a result code beginning with the letter S. The second character in the code indicates the positional accuracy of the resulting point for the geocoded record.
S8 Single match, point located at either the single point associated with an address point candidate or at an address point candidate that shares the same house number. No interpolation is required.
S7 Single match, located at an interpolated point along the candidate’s street segment. When the potential candidate is not an address point candidate and there are no exact house number matches among other address point candidates, the S7 result is returned using address point interpolation.
S5 Single match, point located at a street address position.
S4 Single match, point located at the center of a shape point path (shape points define the shape of the street polyline).
S3 Single match, point located at postal centroid of FSALDU.
S1 Single match, point located at postal centroid of FSA.
S0 Single match, however, no coordinates are available (this is a very rare occurrence).
SC Single match where the original point has been moved a specified distance (usually along a perpendicular line) toward or away from the associated street segment. This result code can be returned only when both a point geocoding dataset and a street segment geocoding dataset are available and when the centerline offset feature is used.

Result Codes

The result codes provide information on how Spectrum Global Address Validation processed U.S. addresses.

Table 4. Result Codes
Field Name Format Description
ApartmentLabel.Result String The result codes for the apartment designator (for example, STE or APT).
-
The input field was empty and supposed to be empty.
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.
ApartmentNumber.Result String The result codes for the apartment number (for example, Apt 3).
-
The input field was empty and supposed to be empty.
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.
City.Result String The result codes for the validated city name.
-
The input field was empty and supposed to be empty.
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.
CitySubdivision.Result String The result codes for the validated urbanization name. This is primarily used for Puerto Rico addresses.
-
The input field was empty and supposed to be empty.
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.
FirmName.Result String The result codes for the validated firm or company name.
-
The input field was empty and supposed to be empty.
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.
HouseNumber.Result String The result codes for the House number (for example, 123 E Main St Apt 3).
-
The input field was empty and supposed to be empty.
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.
LeadingDirectional.Result String The result codes for the leading directional (for example, 123 E Main St Apt 3).
-
The input field was empty and supposed to be empty.
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.
POBox.Result String The result codes for the Post office box number.
Blank
Not applicable.
C
Corrected.
S
Standardized. This option includes any standard abbreviations.
V
Validated. The data was confirmed correct and remained unchanged from input.
PostalCode.Result String The result codes for the postal code. For U.S. addresses, this is the ZIP Code.
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.
PostalCode.Source String The result codes for the postal code source.
Blank
Not applicable.
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 String The result codes for the postal code type.
Blank
Not applicable.
P
Post office box only.
U
Unique ZIP Code™.
M
Military ZIP Code™.
RRHC.Result String The result codes for the rural route/highway contract indicator.
Blank
Not applicable.
C
Corrected.
S
Standardized. This option includes any standard abbreviations.
V
Validated. The data was confirmed correct and remained unchanged from input.
RRHC.Type String The result codes for the rural route/highway contract indicator.
Blank
Not applicable.
HC
Highway contract route.
RR
Rural route.
StateProvince.Result String The result codes for the state or province name.
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, and 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.
StreetName.Alternate.Type String The alternate street name type.
Blank
Not applicable.
A
Alias (other).
B
Base street.
D
Alternate street.
P
Preferred alias.
X
Abbreviated alias.
StreetName.Result String 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, and 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.
StreetName.Type String The street name type.
Blank
Not applicable.
A
Alias (other).
B
Base street.
D
Alternate street.
P
Preferred alias.
X
Abbreviated alias.
StreetSuffix.Result String 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.
TrailingDirectional.Result String The result codes for the trailing directional (for example, 123 Pennsylvania Ave NW).
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.

Input Address

Spectrum Global Address Validation output can include the input address. To include the input address, select the Input address output option.

Table 5. Input Address
Field Name Format Description
AddressLine1.Input String The first address line passed on input.
AddressLine2.Input String The second address line passed on input (USA only).
City.Input String The city/locality/suburb name passed on input.
CitySubdivision.Input String The city/town subdivision passed on input.
LastLine.Input String The last line passed on input.
StateProvince.Input String The state/province passed on input.
StateProvinceSubdivision.Input String The state/province subdivision passed on input.
PostalCode.Input String The postal code passed on input.
Country.Input String The country passed on input.
FirmName.Input String The firm name passed on input.

Country Specific Fields

Spectrum Global Address Validation output can include country specific fields. To include country specific fields in the output, select the Country specific fields output option.

Table 6. Australia (AUS) Country Specific Fields
Field Name Format Description
AUS.Parcel.ID String The GNAF parcel identifier.
AUS.Pid String The GNAF Persistent Identifier (GNAF PID) is a 14-character alphanumeric string that uniquely identifies each GNAF address. The PID is constructed from a combination of the major address fields of the GNAF Dictionary. For example, GAACT718519668.
AUS.Principal.Pid String The Persistent Identifier of the principal address.
AUS.Address.Class String The GNAF address classification.
AUS.SA1 String The GNAF Statistical Area Level 1 (SA1) identifier.
AUS.Level.Number String The number of a floor or level in a multi-story building. For example, Floor 2, 17 Jones Street.

Table 7. Canada (CAN) Country Specific Fields
Field Name Format Description
CAN.BuildingType String Indicates whether a building is a commercial building or an apartment building.

1 Residential (apartment)

2 Commercial

<blank> indicates not a building

CAN.Census.CD String

The Census Division (CD) in which the address is located. For more information about Census Divisions, see: http://www12.statcan.ca/english/census01/Products/Reference/dict/geo008.htm on the Statistics Canada website.

CAN.Census.CMA String

The Census Metropolitan Area (CMA) in which the address is located. For more information about Census Metropolitan Areas, see http://www12.statcan.ca/english/census01/Products/Reference/dict/geo009.htm on the Statistics Canada website.

CAN.Census.CSD String

The Census Subdivision (CSD) in which the address is located. For more information about Census Subdivisions, see http://www12.statcan.ca/english/census01/Products/Reference/dict/geo012.htm on the Statistics Canada website.

CAN.Census.CT String

The Census Tract (CT) in which the address is located. For more information about Census Tracts, see http://www12.statcan.ca/english/census01/Products/Reference/dict/geo013.htm on the Statistics Canada website.

CAN.Census.DA String

The Dissemination Area (DA) in which the address is located. For more information about Dissemination Areas, see http://www12.statcan.ca/english/census01/Products/Reference/dict/geo021.htm on the Statistics Canada website.

Table 8. India (IND) Country Specific Fields
Field Name Format Description
IND.Is.Rural String Indicates whether an address is located in a rural region (village).
IND.POI.Category String Point of interest category. This field describes the type of POI, such as a bank, ATM, or restaurant.
IND.ExtendedResultCode String Block information.
IND.SubLocality String The municipal division below locality level.

Table 9. Ireland (IRL) Country Specific Fields
Field Name Format Description
IRL.Eircode String The Eircode for the address. The Eircode is a seven character alpha-numeric code made up of two parts.
Routing key
The first three characters define a principal post town span of delivery.
Unique Identifier
The last four characters uniquely identify each residential and business address.

Table 10. Italy (ITA) Country Specific Field
Field Name Format Description
ITA.Historical.Postcode String The previous postal code for this address.

Table 11. Japan (JAP) Country Specific Fields
Field Name Format Description
JPN.BANCHI String The block number.
JPN.CHOMOKU String The city block number.
JPN.CHOOAZA String The number for a group of city blocks.
JPN.GO String The house number.
JPN.JUSHOCODE String A point ID that represents a unique address.

Table 12. Netherlands (NLD) Country Specific Field
Field Name Format Description
NLD.EXTENED_POST_CODE String The 6-digit postal code. The output contains a candidate’s 6-digit postal code if one is available.

Table 13. New Zealand (NZL) Country Specific Fields
Field Name Format Description
NZL.Aliased.SUBURB String The New Zealand aliased suburb. An alternative to the officially-recognized suburb name.

Table 14. United Kingdom (GBR) Country Specific Fields
Field Name Format Description
GBR.DependentStreet.Name String The addresses in the United Kingdom may contain two street names: a main street name and dependent street name. Some addresses may not contain a street name at all.
GBR.Dependent.Locality String The dependent locality name. A dependent locality is a large village or district. For example, Wimbledon.
GBR.DoubleDependent.Locality String The double dependent locality name. A double dependent locality is a small village or subdistrict.
GBR.Historic.Postcode String If the input address contained an old postal code that has been replaced by a new postal code, this field contains the old postal code.
GBR.Aliased.Locality String A locality that is not part of the postal address.
GBR.OSAPR String The Ordnance Survey Address Point reference (OSAPR). Each address has a unique OSAPR. OSAPRs are always 18 characters long and must start with the letters AP.
GBR.UPRN String The Unique Property Reference Number. The UPRN is a unique identifier that provides a persistent reference to a unique property, regardless of changes in the property name, status, subdivision, use (such as from single occupancy to multiple occupancy), or demolition of the property. All historic, alternative, and provisional addresses are recorded against the same UPRN. The UPRN field is not returned for Northern Ireland addresses.
GBR.RPC String The RPC identifies the positional accuracy of the candidate. The RPC describes the accuracy of the coordinates allocated to the address.

Table 15. United States (USA) Country Specific Fields
Field Name Format Description
USA.AbbreviatedCityName String The abbreviated city name.
USA.AddressLocation String The location where the address information was found.
01
Input address found on address line 1.
02
Input address found on address line 2.
03
Input address found on address lines 1 and 3.
04
Firm found on input address line 1. No address line found.
06
Input address found on address line 2. Firm found on address line 1.
08
Firm found on input address line 2. No address line found.
09
Input address found on address line 1. Firm found on address line 2.
80
Address line not found.
USA.AdvancedBarcode String The returned 14-digit barcode consisting of the beginning frame character, ZIP Code, ZIP + 4, delivery point, check digit, and end framing character.
USA.AltStreet String The returned alternate street name.
USA.AltStreetType String The returned alternate street name type.
B
Base street.
A
Alias (other).
D
Alternate street.
P
Preferred alias.
X
Abbreviated alias.
USA.Apartment1 String The first apartment (unit) field in the address. This field is used for output. This field will only be populated if the Save unit in separate field is selected. If selected, the data is not included on the AddressLineX field(s).
USA.Apartment2 String The second apartment (unit) field in the address. This field is used for output. This field will only be populated if the Save unit in separate field is selected. If selected, the data is not included on the AddressLineX field(s).
USA.BCCheckDigit String The valid one-digit modulo check digit required for printing the correct barcode.
USA.CarrierRouteCode String The returned carrier route code.
USA.CASSAddressLine1 String For successfully-coded addresses, the output label line Address Line 1 contains the coded address line information.
USA.CASSAddressLine2 String For successfully-coded addresses, the output label line Address Line 2 contains the city/state/ZIP Code information.
USA.CASSCityName String The city name. The city name returned here is the city name mandated by USPS regulations. Variations of the city name (for example, full, abbreviated, and non-mailing) are returned in alternate fields.
USA.CongressionalDistrict String The returned congressional district.
USA.DefaultMatch String The returned default match.
Y
Carrier route, or ZIP + 4, or DPBC default values returned.
Blank
No default values returned.
USA.DPV String The returned Delivery Point Validation (DPV) indicators.
N
The address is not a valid delivery point. The USPS cannot deliver mail to this address.
Y
The address is delivery point validated. Primary range and secondary range (when present) are valid. The USPS can deliver mail to this address.
S
This address contains a valid primary range. Secondary range is present but is not confirmed. The USPS can deliver mail to this address.
D
This address contains a valid primary range. Secondary range is missing. The USPS can deliver mail to this address.
USA.DPV.CMRA String The returned Commercial Mail Receiving Agents (CMRA) indicators.
Y
The address is a valid CMRA.
N
The address is a confirmed delivery point but is not a valid CMRA.
Blank
This field is blank if the address is not a confirmed delivery point.
USA.DPV.DNA String The DPV Door Not Accessible (DNA) Table status indicator. The DNA Table identifies delivery addresses where carriers cannot knock on the door for mail delivery or where carriers cannot physically access a residence/building such as rural/highway contact route (HCR), long driveway, or gated community.
Y
The address was found in the DPV DNA Table.
N
The address was not found in the DPV DNA Table.
Blank
The DPV DNA Table was not queried.
USA.DPV.FalsePositive String The DPV False Positive Flag.
Y
The address is not a confirmed delivery point and a positive response was received from the False Positive File.
N
The address is not a confirmed delivery point and a negative response is received from the False Positive File. This field is blank if the address is a confirmed delivery point.
Blank
The False/Positive Table was not queried.
USA.DPV.Footnote String The returned DPV footnote code.
A1
Input address did not match to the ZIP + 4 File.
AA
Input address matched to the ZIP + 4 File.
BB
Input address matched to DPV (all components).
CC
Input address primary number matched to DPV but secondary number did not match (present but invalid).
F1
Input address matched to a military ZIP Code.
G1
Input address matched to a General Delivery address.
M1
Input address primary number missing.
M3
Input address primary number is invalid.
N1
Input address primary number matched to DPV but address is missing secondary number.
P1
Input address missing PO Box, rural route, or highway contract number.
P3
Input address PO Box, rural route, or highway contract number invalid.
PB
Input address is a PO Box Street Address (PBSA).
R1
Input address matched to CMRA but secondary number is not present.
R7
Input address is a Carrier Route R777.
RR
Input address matched to CMRA.
U1
Input address matched to a unique ZIP Code.
USA.DPV.LeadingDirectional String The parsed street predirectional for the record creating the False Positive (Seed) Table violation.
USA.DPV.MatchedZIP String The parsed ZIP Code for the record creating the False Positive (Seed) Table violation.
USA.DPV.MatchedZIP4 String The parsed Plus4 ZIP Code for the record creating the False Positive (Seed) Table violation.
USA.DPV.NoStat String The DPV No-Stat Table status.
Y
The address was found in the DPV No-Stat Table.
N
The address was not found in the DPV No-Stat Table.
Blank
The DPV No-Stat Table was not queried.
USA.DPV.NSL String The DPV No Secure Location (NSL) Table status.
Y
The address was found in the in the DPV NSL Table.
N
The address was not found in the DPV NSL Table.
Blank
The DPV NSL Table was not queried.
USA.DPV.PBSAFound String The DPV PO Box Street Address (PBSA) Table status indicator.
Y
The address was found in the DPV PBSA Table.
N
The address was not found in the DPV PBSA Table.
Blank
The DPV PBSA Table was not queried.
USA.DPV.Range String The parsed street primary range for the record creating the False Positive (Seed) Table violation.
USA.DPV.SeedHit String The DPV False Positive (Seed) Table indicator.
Y
The address was found in the in the DPV False Positive (Seed) Table.
N
The address was not found in the DPV False Positive (Seed) Table.
USA.DPV.StreetName String The street name for the address creating the False Positive (Seed) Table violation.
USA.DPV.Suffix String The street suffix for the address creating the False Positive (Seed) Table violation.
USA.DPV.Throwback String The DPV P.O. Box Throwback Table indicator.
Y
The address was found in the in the DPV P.O. Box Throwback Table.
N
The address was not found in the DPV P.O. Box Throwback Table.
Blank
The DPV P.O. Box Throwback Table was not queried.
USA.DPV.TrailingDirectional String The street postdirectional for the address creating the False Positive (Seed) Table violation.
USA.DPV.UnitDesignator String The unit designator for the address creating the False Positive (Seed) Table violation.
USA.DPV.UnitNumber String The unit number for the record creating the False Positive (Seed) Table violation.
USA.DPV.Vacant String The DPV Vacant Table indicator.
Y
The address was found in the DPV Vacant Table.
N
The address was not found in the DPV Vacant Table.
Blank
The DPV Vacant Table was not queried.
USA.DPV.ZIP4 String The ZIP + 4 used for DPV processing.
USA.EWSFailure String The address was not matched because the address was found in the USPS Early Warning System (EWS) File.
USA.FIPSCountyNumber String The returned five-digit FIPS code. Positions 1 and 2 contain the state code. Positions 3 through 5 contain the county code. Used for output information only.
USA.FiveDigitBarcode String The returned five-digit barcode.
USA.FiveDigitScheme String The returned 5-digit combined ZIP Code.
USA.FullCityName String The full city name.
USA.LACS String The LACSLink status.
L
The address is eligible for LACSLink processing.
Blank
No LACSLink processing available.
USA.LACS.Indicator String The one-byte CASS Stage file LACSLink Indicator value. If you are not performing a CASS Stage test, this field can be ignored. If you are performing a CASS Stage test, use the value in this field to populate the stage record.
Y
Record found in the LACSLink False Positive (Seed) Table.
N
Record not found in the LACSLink False Positive (Seed) Table.
USA.LACS.PreLACSAddress String The input address before LACSLink processing.
USA.LACS.PreLACSLeadingDirectional String The input address street predirectional determined before LACSLink processing.
USA.LACS.PreLACSMatchedZIP String The input address matched ZIP Code determined before LACSLink processing.
USA.LACS.PreLACSMatchedZIP4 String The input address matched ZIP+4 Code determined before LACSLink processing.
USA.LACS.PreLACSRange String The input address street primary range determined before LACSLink processing.
USA.LACS.PreLACSStreetName String The input address street name determined before LACSLink processing.
USA.LACS.PreLACSSuffix String The input address street suffix determined before LACSLink processing.
USA.LACS.PreLACSTrailingDirectional String The input address street postdirectional determined before LACSLink processing.
USA.LACS.PreLACSUnitD String The input address unit designator determined before LACSLink processing.
USA.LACS.PreLACSUnitN String The input address unit number determined before LACSLink processing.
USA.LACS.ReturnCode String The LACSLink return code.
A
LACSLink processing successful. Record matched through LACSLink processing.
00
LACSLink processing failed. No matching record found during LACSLink processing.
09
LACSLink processing matched the input address to an older highrise default address. The address has been converted. However, rather than provide an imprecise address, LACSLink processing does not provide a new address.
14
LACSLink processing failed. Match found during LACSLink processing but conversion did not occur due to other USPS regulations.
92
LACSLink processing successful. Record matched through LACSLink processing. Unit number dropped on input.
USA.LACS.SeedHit String Indicates if the address was found in the LACSLink False Positive (Seed) Table.
Y
The address was found in the LACSLink False Positive (Seed) Table.
N
The address was not found in the LACSLink False Positive (Seed) Table.
USA.LOTCode String The returned enhanced Line of Travel (eLOT) code. Used for output information only. If eLOT is unavailable, the default value is 0000D.
USA.LOTSequence String The last character of the eLOT code indicates eLOT sequence.
A
Ascending.
D
Descending.
USA.MatchLevel String The returned match level.
F
Firm record match.
G
General delivery match.
H
Highrise match.
P
PO Box match.
R
Rural route/highway contract match.
S
Street level match.
USA.NonMailingCityName String The non-mailing city name. A city name that is recognized by the USPS, but is not the preferred name for the ZIP Code. This is often a vanity name for the area.
USA.Parsed.AltPostDirectional String The parsed alternate post directional.
USA.Parsed.AltPreDirectional String The parsed alternate pre-directional.
USA.Parsed.AltRange String The parsed alternate range.
USA.Parsed.AltStreetName String The parsed alternate street name.
USA.Parsed.AltStreetSuffix String The parsed alternate suffix.
USA.Parsed.PMUnitDesignator String The parsed PMB or MSC designator.
USA.Parsed.PMUnitNumber String The parsed PMB or MSC unit number.
USA.Parsed.PostDirectional String The parsed post-directional.
USA.Parsed.PreDirectional String The parsed pre-directional.
USA.Parsed.Range String The parsed primary range.
USA.Parsed.StreetName String The parsed street name.
USA.Parsed.StreetSuffix String The parsed street suffix.
USA.Parsed.Unit2Designator String The parsed second unit designator.
USA.Parsed.Unit2Number String The parsed second unit number.
USA.Parsed.UnitDesignator String The parsed unit designator.
USA.Parsed.UnitNumber String The parsed unit number.
USA.POBoxOnly String The PO Box only delivery zone status indicator.
Y
The address ZIP Code is a PO Box only delivery zone.
N
The address ZIP Code is not a PO Box only delivery zone.
Blank
Unable to determine USPS ZIP Code for input address.
USA.PostalBarcode String The returned delivery point barcode.
USA.PreferredCityName String The preferred city name for ZIP Code.
Note: For successfully-coded addresses, the USA.PreferredCityName and the USA.PreferredState fields are always populated.

For non-coded addresses, the USA.PreferredCityName and the USA.PreferredState fields are populated in the following scenarios:

  • ZIP Code only input (city not input, or not found).
  • Single ZIP Code city input (ZIP Code not input, or not found).
  • City/St/ZIP Code input and agree (ZIP Code is part of city).

For all other non-coded scenarios, the preferred fields are blank.

USA.PreferredState String The preferred state abbreviation for the preferred city name.
Note: For successfully-coded addresses, the USA.PreferredCityName and USA.PreferredState fields are always populated.

For non-coded addresses, the USA.PreferredCityName and USA.PreferredState fields are populated in the following scenarios:

  • ZIP Code only input (city not input, or not found).
  • Single ZIP Code city input (ZIP Code not input, or not found).
  • City/St/ZIP Code input and agree (ZIP Code is part of city).

For all other non-coded scenarios, the preferred fields are blank.

USA.PrivateMailbox String The returned matched Private Mail Box (PMB) or Mail Stop Code (MSC).
USA.PrivateMailbox.Input String Reserved for future use.
USA.PrivateMailbox.Type String Reserved for future use.
USA.PrivateMailbox.Type.Input String Reserved for future use.
USA.RDI String The returned Residential Delivery Indicator (RDI).
Y
The address is a residential delivery.
N
The address is a business delivery.
Blank
The address failed address lookup (did not return a ZIP+4), or RDI was not active.
USA.SeasonalFlags String The seasonal delivery indicator beginning with January. The seasonal indicators for the returned ZIP Code. These indicators identify, at the 5-digit ZIP Code level, the months in which seasonal addresses receive delivery. There are 12 monthly flags (January through December). A "Y" in one of the monthly slots indicates that seasonal addresses are delivered mail in the month indicated by that slot. This field is blank if there are no seasonal deliveries for the ZIP Code.
Y
Deliver mail in this month.
N
Do not deliver mail in this month.
USA.Status String The match status of the address.
F
The address failed to match.
Blank
The address was successfully matched.
USA.Status.Code

USA.Status.Description

String The returned match status code.
4101
No city, state, and ZIP Code in address.
4102
No ZIP Code and no city name in address.
4103
No ZIP Code and no state name in address.
4104
Cannot match to Unique ZIP Code.
4211
Invalid ZIP Code and no city name in address.
4212
No ZIP Code and invalid city name in address.
4213
Invalid ZIP Code and invalid city name in address.
4301
No street name in input address.
4399
Blank address record.
4411
No primary street name found in the Global Address Validation database.
4412
No primary names ranked with certainty.
4421
Invalid range or house number.
4422
Incorrect or missing directional.
4423
Incorrect or missing suffix.
4425
Incorrect or missing suffix and directional.
4450
No range in input address.
4451
Multiple component failure. An address component had multiple options causing the address to fail assignment.
4460
EWS Failure. Address found on EWS table.
4461
eLOT assignment has failed. Address coded successfully but eLOT code not assigned.
4465
The address requires a firm. No firm was provided or the firm failed to match.
4466
The address requires secondary addresses (there is no default street address). No secondary was provided or the secondary did not match.
4467
The address coded but was flagged for ZIP Move processing. The address failed to meet the final ZIP Move criteria. ZIP Move processing requires an exact match of street, suffix, and directional (both pre and post).
4500
Unable to code. If reason for inability to code cannot be determined, this error is issued.
4600
Undeliverable address in the Global Address Validation database.
Note: This status code can still be valid with a successfully matched address. The combination of the two codes indicates that this is a valid address but is not deliverable by USPS standards.
4601
The address failed Delivery Point Validation (DPV) processing.
4602
The address is flagged as Carrier Route R777 and is not eligible for street delivery. This status code is only generated if the option R777 Deliverable is not activated.
4801
Address is locked and was not be processed.
5101
Warning: Missing apt/suite number.
5102
Warning: Apt/suite was input but is not valid.
5103
Warning: Input firm name is missing or invalid.
5104
Warning: Multiple firms returned for address.
5105
Warning: PO Box number is invalid or unavailable.
5106
Warning: Apt/Suite was input but not allowed for this address.
5200
Information: Address bypassed counted correct in Process Unassign run.
USA.StreetNameAliasType String The type of alias street name. An alias street name is an alternate name for a street, maintained at the 5-digit ZIP Code level.
Abbreviated
The alias street name is an abbreviation of the street name. For example, HARTS-NM RD is an abbreviated alias for HARTSVILLE NEW MARLBORO RD.
Changed
The official street name changed and the alias street name reflects the new official street name. For example, if SHINGLE BROOK RD is changed to CANNING DR, then CANNING DR would be a changed alias type.
Other
The alias street name is made up of nicknames, other names, or common abbreviations for the street name.
Preferred
The alias street name is the USPS preferred alias street name.
USA.SuiteLink.Fidelity String The SuiteLink fidelity code.
1
All words in the business name match.
2
Acceptable match. One or more words in the business name did not match, but acceptance criteria was still met.
3
Unacceptable match. One or more words in the business name did not match. Acceptance criteria was not met.
USA.SuiteLink.MatchCode String The SuiteLink match code.
A
SuiteLink match found.
B
No SuiteLink match found.
C
Business name normalized to a blank value.
D
ZIP + 4 Code not recognized as a high-rise default.
E
SuiteLink database expired.
USA.SuiteLink.ReturnCode String The SuiteLink return code.
A
Successful SuiteLink match.
00
Failed SuiteLink match.
USA.VeriMoveDataBlock String Reserved for future use.
USA.ZIPValid String The returned ZIP Code.
USA.ZIP4Valid String The returned ZIP + 4 Code.