Address
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
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
OutputFormattedOnFail=Y
in your
request.
Response Element |
Description |
---|---|
AdditionalInputData |
Input data not used by the address validation process. |
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 OutputCountryFormat:
|
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 OutputRecordType=E. If you want formatted data in the Parsed Address format to be returned when validation fails (that is, a normalized address), specify OutputFormattedOnFail=Y.
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 OutputCountryFormat:
|
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:
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 |
|
ApartmentNumber.Result |
|
City.Result |
|
Country.Result |
These result codes do not apply to U.S. or Canadian addresses.
|
FirmName.Result |
|
HouseNumber.Result |
|
LeadingDirectional.Result |
|
POBox.Result |
|
PostalCode.Result |
|
PostalCode.Source |
These result codes apply to U.S. addresses only.
|
PostalCode.Type |
|
RRHC.Result |
|
RRHC.Type |
These result codes apply to U.S. addresses only.
|
StateProvince.Result |
|
StreetName.Result |
|
TrailingDirectional.Result |
|
USUrbanName.Result |
These result codes apply to U.S. addresses only.
|
ApartmentLabel2.Result |
|
ApartmentNumber2.Result |
|
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.
|
StreetSuffix.Result |
The result codes for the street name (for example, 123 E Main St Apt 3).
|
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 OutputCountryFormat:
|
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:
|
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) |
Address Match Results
Response Element |
Description |
---|---|
AddressMatch.LocationCode |
The Location Code indicates the methodology used to complete the geocode and may also provide some information about the quality of the geocode. |
AddressMatch.LastLine |
The complete matched last address line (city, state, and postal code). |
AddressMatch.UrbanizationName |
Urbanization name. Used for addresses in Puerto Rico. |
AddressMatch.Firm | The name of the business if the address is a business address. |
AddressMatch.Zip | The matched address five-digit ZIP Code. |
AddressMatch.Zip4 | The matched address four-digit ZIP Code extension. |
AddressMatch.HouseNumber | Building number for the address. |
AddressMatch.PreDirectional | Leading directional. For example, 123 E Main St Apt 3. |
AddressMatch.Street | The name of the street, not including any directionals or suffixes. For example, the word "Main" in this address: 123 E Main St Apt 3. |
AddressMatch.StreetType | The street type of the matched location. For example, AVE for Avenue. |
AddressMatch.UnitType | The type of unit, such as apartment, suite, or lot. |
AddressMatch.UnitNumber | Apartment number. For example, 123 E Main St APT 3. |
AddressMatch.NumCandidates | When there are multiple equally-scored matches, returns the number of multiple match candidates found. |
AddressMatch.GenRC | General Return Code indicating the type of match. Blank Did not match.
|
AddressMatch.DataTypeName | Indicates the file from which the match was obtained. One of the following:
|