Mapping output attribute

Learn about the output mapping between a Reltio attribute and its corresponding cleanse attribute.

This table shows the output mapping between Reltio attributes and their corresponding cleanse attributes.

To see this type of mapping in practice, view the contents of this file: sampleoutputmapping.xml.

Table 1. Output Attribute Mapping
Reltio Attribute	Cleanse Attribute	Description
`VerificationStatus`	`VerificationStatus`	The verification status of the location's postal address, as returned from the address verification/cleansing service.
`VerificationStatusDetails`	`VerificationStatusDetails`	The details related to the returned verification status of the location's postal address, as provided by the address verification/cleansing service.
`StateProvince`	`AdministrativeArea`	The most common geographic data element within a country. For example, any US state or Canadian province.
`City`	`Locality`	The most common population center data element within a country. For example, any US city or Canadian municipality.
`SuperAdministrativeArea`	`SuperAdministrativeArea`	The largest geographic data element within a country
`DoubleDependentLocality`	`DoubleDependentLocality`	The smallest population center data element, dependent on both the contents of the `Locality` and `DependentLocality` fields. For example, a UK Village.
`Neighborhood`	`DependentLocality`	A smaller population center data element, dependent on the contents of the Locality field. For example, a Turkish Neighborhood.
`DependentThoroughfare`	`DependentThoroughfare`	The dependent street or block data element within a country. For example, a UK Dependent Street.
`Country`	`CountryName`	The official name of the country as per ISO 3166.
`Zip5`	`PostalCodePrimary`	The primary postal code used for a particular country. For example, the USA Zip, Canadian Postcode, or Indian PINcode.
`Zip4`	`PostalCodeSecondary`	The secondary postal code information, if used in a particular country and if such detail is able to be determined and reference data is available. For example, the USA Zip Plus 4.
`Latitude`	`Latitude`	The latitude coordinates of the address.
`Longitude`	`Longitude`	The longitude coordinates of the address.
`GeoAccuracy`	`GeoAccuracy`	Denotes if the geocodes associated with the address have been identified. It is made up of the following values: Geocoding status, which can be P - Point A single geocode was found matching the input address I - Interpolated A geocode was able to be interpolated from the input addresses location in a range A - Average Multiple candidate geocodes were found to match the input address, and an average of these was returned U - Unable to geocode A geocode was not able to be generated for the input address Geocoding level 4 - Premise (Premise or Building) 3 - Thoroughfare 2 - Locality 1 - AdministrativeArea 0 - None
`POBox`	`PostBox`	The post box for a particular delivery point, should one exist.
`Telephone`	`Telephone`	The phone number of the address.
`SubAdministrativeArea`	`SubAdministrativeArea`	The smallest geographic data element within a country. For example, a US county.
`Building`	`Building`	The name identifying an individual location or building at the location's postal address.
`SubBuilding`	`SubBuilding`	The secondary identifiers for a particular delivery point. For example, "FLAT 1" or "SUITE 212".
`Organization`	`Organization`	The business name associated with a particular delivery point, should one exist.
`DeliveryAddress1`	`DeliveryAddress1`	The first line of the location's postal address.
`AddressLine1`	`DeliveryAddress1`	The first line of the location's postal address.
`AddressLine2`	`DeliveryAddress2`	The second line of the location's postal address.
`ISO3166-2`	`ISO3166-2`	The ISO 3166 2-character country code of the location's postal address.
`ISO3166-3`	`ISO3166-3`	The ISO 3166 3-character country code of the location's postal address
`DeliveryAddress`	`DeliveryAddress`	The full address minus the `Organization`, `Locality`, `AdministrativeArea` hierarchy and `PostalCode` hierarchy fields, correctly formatted for mailing in the relevant country, including line breaks specified using the `AddressLineSeparator` option.
`PremiseNumber`	`PremiseNumber`	The alphanumeric indicator within the `Premise` field, should one exist. For instance, if `Premise` contains "Plot 7/7A" `PremiseNumber` contains "7/7A" if a sufficient level of parsing detail exists within a particular country.
`Premise`	`Premise`	The alphanumeric code identifying an individual location, should one exist.
`Street`	`Thoroughfare`	The most common street or block data element within a country. For example, USA Street.
`ISO3166-N`	`ISO3166-N`	The ISO 3166 3-digit numeric country code.
`Unmatched`	`Unmatched`	Any information in the input address fields that is unable to be parsed to a particular address field.
`AVC`	`AVC`	The Address Verification Code (AVC), which is response code which includes information associated with the parsing and matching of the address record. Use this to identify the level to which an address has been verified.
`AutoZoneIndicator`	`AutoZoneIndicator`	Indicates if carrier route sort rates apply to the location's postal address.
`CarrierRoute`	`CarrierRoute`	The Carrier route code assigned to a mail delivery or collection route within a 5-digit ZIP Code.
`CMRAIndicator`	`CMRAIndicator`	Indicates if the location's address is associated with a Commercial Mail Receiving Agency (CMRA), more commonly referred to as a maildrop.
`CongressionalDistrict`	`CongressionalDistrict`	The congressional district, or the electoral division in American politics, to which the address belongs.
`DefaultFlag`	`DefaultFlag`	Indicates if the address matches to a high rise default, rural route default, or street default record when compared to the USPS' ZIP+4 file.
`DeliveryPointBarCode`	`DeliveryPointBarCode`	The 3-digit code that is made of up of a 2-digit delivery point code and an appended check digit. Note: This 3-digit code when suffixed to a 5-digit ZIP code and it's corresponding 4-digit ZIP+4 results in the12-digit POSTNET barcode of your address. In other words - 5 (ZIP Code) + 4 (ZIP+4) + 3 (DPBC) = 12 digit POSTNET barcode.
`DPVConfirmedIndicator`	`DPVConfirmedIndicator`	Indicates the delivery status at the delivery point of the location's postal address.
`DPVFootnotes`	`DPVFootnotes`	Used in conjunction with the `DPVConfirmedIndicator` field, the Delivery Point Validation footnotes contains crucial details that help understand the input address' validity and deliverability. This can contain one or more 2-character footnotes. For more information about the DPVFootnote codes and description, see table DPV Footnotes.
`eLOTCode`	`eLOTCode`	Indicates the first occurrence of delivery made to the add-on range within the carrier route. This is used with the Enhanced Line of Travel (eLOT) service that enables mailers to earn lower rates by sorting based on delivery sequence.
`eLOTNumber`	`eLOTNumber`	Indicates the approximate delivery order within the sequence number. Used with Enhanced Line of Travel (eLOT) service that enables mailers to earn lower rates by sorting based on delivery sequence.
`EWSFlag`	`EWSFlag`	Indicates whether an address matched a record in the EWS (Early Warning System) file for newer addresses (resulting in a ZIP+4 no match).
`FalsePositiveIndicator`	`FalsePositiveIndicator`	Indicates whether a mailing list is being generated or created during validation, as creating a mailing list through DPV certification is disallowed by the USPS.
`FIPSCountyCode`	`FIPSCountyCode`	The unique 3-digit Federal Information Processing Standard (FIPS) code that is used to identify a county.
`LACSLinkCode`	`LACSLinkCode`	The code returned by LACSLink^® after querying the LACSLink^® database.
`LACSLinkIndicator`	`LACSLinkIndicator`	The indicator returned by LACSLink^® after querying the LACSLink^® database.
`LACSStatus`	`LACSStatus`	Displays the value L if the input address matched an entry in the Locatable Address Conversion Service database. This confirms that the input address was converted from a rural-style address to a city-style address.
`NoStatIndicator`	`NoStatIndicator`	Indicates the address is not receiving delivery, and the address is not counted as a possible delivery.
`PMBNumber`	`PMBNumber`	The Private Mail Box (PMB) number to be appended to the `PrimaryAddressLine` field, if applicable. This is followed by the `PMB Type`.
`PMBType`	`PMBType`	The Private Mail Box (PMB) type to be appended to the `PrimaryAddressLine` field, if applicable. Ensure this comes before the PMB Number.
`PrimaryAddressLine`	`PrimaryAddressLine`	The primary delivery address line used in CASS certified address validation.
`RecordType`	`RecordType`	The Record type of an address that has been confirmed as a valid delivery address.
`ReturnCode`	`ReturnCode`	The code that provides additional information about the data returned for the delivery point of the location's postal address.
`ResidentialDelivery`	`ResidentialDelivery`	Indicates if the address is residential.
`SecondaryAddressLine`	`SecondaryAddressLine`	The secondary delivery address line, if present, that is used in CASS certified address validation.
`SUITELinkFootnote`	`SUITELinkFootnote`	The code that is returned after querying the SuiteLink^® database. This code indicates whether the input address matched a record in the SuiteLink^® database.
`VacantIndicator`	`VacantIndicator`	Indicator that the delivery point of the location's postal address was active in the past, but is currently vacant, has most likely been unoccupied for over 90 days, and is not receiving deliveries.
Additional cleanse output fields		Enabled by server options or when parsing is supported for a given country or region.
`ID`	`ID`	Optional field passed through from input to output without modification.
`AddressFormat`	`AddressFormat`	Displays the hierarchical structure used to build the `Address` field, if `OutputAddressFormat` is enabled.
`DeliveryAddressFormat`	`DeliveryAddressFormat`	Displays the hierarchical structure used to build the `DeliveryAddress` field, if `OutputAddressFormat` is enabled.
`AQI`	`AQI`	Address Quality Index score. Reflects completeness and confidence of verification. See the table below for details.
`Sequence`	`Sequence`	Indicates the order of the address in a multi-record input request. For example, "3" means third address processed.
`Contact`	`Contact`	Pass-through field containing contact name information.
`Function`	`Function`	Pass-through field for function or job title information.
`Department`	`Department`	Pass-through field for organizational department details.
`AdministrativeAreaType`	`AdministrativeAreaType`	Type indicator of the `AdministrativeArea`. For example, “City” in “Taipei City.”
`AdministrativeAreaName`	`AdministrativeAreaName`	Name component of the `AdministrativeArea`. For example, “Taipei.”
`AdministrativeAreaTrailingType`	`AdministrativeAreaTrailingType`	Trailing type of the `AdministrativeArea`. For example, “City.”
`LocalityExtra`	`LocalityExtra`	Additional locality information not defined by the postal authority, but needed for parsing. Example: CEDEX (France).
`LocalityName`	`LocalityName`	Name portion of the `Locality`, when separate from type.
`LocalityType`	`LocalityType`	Type indicator of the locality. Example: “Dist.” for district.
`LocalityTrailingType`	`LocalityTrailingType`	Trailing text that identifies the locality type (e.g., “City”, “Dist.”).
`DependentLocalityName`	`DependentLocalityName`	Name component extracted from the `DependentLocality`.
`DependentLocalityType`	`DependentLocalityType`	Type component extracted from the `DependentLocality`. For example, “Qu.”
`DependentLocalityLeadingType`	`DependentLocalityLeadingType`	Leading type label within the `DependentLocality`. Example: “Rancheria.”
`DoubleDependentLocalityName`	`DoubleDependentLocalityName`	Name portion within the `DoubleDependentLocality`, when separately parsed.
`DoubleDependentLocalityType`	`DoubleDependentLocalityType`	Type portion within the `DoubleDependentLocality`. Example: “Zhen.”
`ThoroughfarePreDirection`	`ThoroughfarePreDirection`	Directional prefix in the `Thoroughfare`, such as “N” in “N Main St.”
`ThoroughfareType`	`ThoroughfareType`	Street type associated with the `Thoroughfare`, such as “Ave,” “Str.,” or “Rua.”
`BuildingType`	`BuildingType`	Label or classification associated with a `Building` field. Example: “城.”
`SubBuildingBlock`	`SubBuildingBlock`	Block-level identifier associated with a sub-building. Example: “BLOQUE 7.”
`SubBuildingDoor`	`SubBuildingDoor`	Door identifier used within a sub-building. Example: “PUERTA D.”
`SubBuildingStaircase`	`SubBuildingStaircase`	Staircase identifier associated with a sub-building. Example: “STAIRCASE B.”
`OrganizationTrailingType`	`OrganizationTrailingType`	Legal entity suffix for organizations. Examples: “Corp.,” “GmbH.”
`ResCom_Flag`	`ResCom_Flag`	Indicates address type: Res (residential), Com (commercial), R/C (both), or Unk (unknown).

The Address Quality Index (AQI) is used to indicate the quality of an address, e.g., Excellent quality, Good quality, Average quality, Poor quality, and Bad quality. Any record that is able to be parsed will have an AQI.

Two factors decide the address quality, post-processed verification match level and Matchscore.

This offers a view of overall address quality, but it is not used as a metric for deciding whether to accept an address which has been processed via Verify.Please use the AVC to verify addresses.

Table 2. Address Quality Index
AQI	Address Quality	Explanation	Verification level	Matchscore
A	Excellent	Verifiable to at least Premise level without changes	≥4	100
B	Good	Verifiable to at least Thoroughfare level with minor changes	≥3	≥95
C	Average	Verifiable to at least Locality level with moderate changes	≥2	≥90
D	Poor	Only verifiable to at least Locality level with more than moderate changes	≥2	≥80
E or Empty	Bad	If an address is unable to be parsed, the AQI can be empty.	else	else

Table 3. DPV Footnotes
Code	Description
AA	Street, city, state and ZIP are valid. Address matched a record in the ZIP+4 file.
A1	Address not found in the ZIP+4 file. Address is invalid
BB	All address components are confirmed. Address is a deliverable address
C1	Address is a deliverable address after dropping the subbuilding number from the input address. Subbuilding is required.
CC	Address is a deliverable address after dropping the subbuilding number from the input address. Subbuilding is not required.
F1	Address matched to a military address
G1	Address matched to a general delivery address
IA	Informed Address identified. This replaces the recipient's name and street address with a special code in the address block. The only information that most people will be able to see about the recipient will be their city, state, and ZIP5.
N1	Found a DPV match to the premise number but the subbuilding number is missing from the input record
M1	Premise number is missing
M3	Premise number is invalid
P1	PO, RR, HC Box number missing
P3	PO, RR, HC Box number is invalid
PB	Input address matched to a post office box street address
RR	Address matched to CMRA and PMB designator is present
R1	Address matched to CMRA but PMB designator is not present
R7	Input address matched to a physical address that does not receive delivery from the USPS (R777 or R779)
TA	Input address premise matched by dropping trailing alpha
U1	Address matched to a unique ZIP Code

Unify and manage your data

Mapping output attribute

Footer