Processing mode

Whether to verify the input address or search all installed data and return multiple results.

Verify (Best Match): 1 to 1 - Checks the reference data and returns the best match.

Verify (Allow Multiple Results): Attempts to verify the input address 1 to 1, but allows Address Verification to return multiple possible results if the input address has an Ambiguous verification result.

Search: 1 to Many - Checks the reference data and returns multiple matches. Allows searching across countries, for example.

Maximum number of results

An optional upper limit on number of results that can be returned.

Note: This field is greyed out if Verify (Best Match) is selected.

Numeric field, maximum of 15 characters.

Geocode

Whether matching geocodes are to be returned.

Yes

No

Output address separator

The symbol used to separate the address elements.

Selection of punctuation symbols and special characters.

Output script

The output is converted into the script selected.

Drop-down list of available scripts. Native - the default - returns the output in its original script.

Output Casing

The case the output is returned in.

The available options are Title (default - the first character of each word is upper case, the others are lower case), Upper or Lower.

Additional options

Free-text field.

There are additional options available that are not listed on the Address Verification: Options tab.

To use these options, enter them and the specified value in this free-text field. For example:

RangeDecompose=Match

ToolInfo=Yes

Note:

• The field accepts options in any valid Java .properties key and value format.

• See the Loqate support website for a full list of available options and possible values.

• To enable CASS (fields prefixed with avverify.cass), enter CertifiedCountryList=USA into this field.

• To enable AMAS (fields prefixed with avverify.amas), enter CertifiedCountryList=AUS into this field.

• To enable SERP (fields prefixed with avverify.serp), enter CertifiedCountryList=CAN into this field.

av.Address

The full address, matched/verified and correctly formatted for mailing in the relevant country.

av.CountryName

The full country name.

av.ISO3166-2

The ISO3166 two-character country code.

av.ISO3166-3

The ISO3166 three-character country code.

av.ISO3166-N

The ISO3166 three-digit numeric country code.

av.SuperAdministrativeArea

The largest geographic data element within a country.

av.AdministrativeArea

The most common geographic data element within a country; e.g. a US state or Canadian Province.

av.SubAdministrativeArea

The smallest geographic data element; e.g. a US county.

av.Locality

The most common population center data element in a country; e.g. a city or municipality.

av.DependentLocality

A smaller population center data element; e.g. a Turkish neighborhood.

av.DoubleDependentLocality

The smallest population center data element, depending on the contents of the Locality and DependentLocality fields; e.g. a UK village.

av.Thoroughfare

The most common street or block data element within a country; e.g. a street.

av.ThoroughfarePreDirection

The prefix direction contained within the Thoroughfare field. E.g. if Thoroughfare contains "N MAIN ST" ThoroughfarePreDirection will contain "N".

av.ThoroughfareLeadingType

The leading thoroughfare type indicator within the Thoroughfare field. E.g. if Thoroughfare contains "RUE DE LA GARE" ThoroughfareLeadingType will contain "RUE".

av.ThoroughfareName

The name indicator within the Thoroughfare field. E.g. if Thoroughfare contains "N MAIN ST" ThoroughfareName will contain "MAIN".

av.ThoroughfareTrailingType

The trailing thoroughfare type indicator within the Thoroughfare field. E.g. if Thoroughfare contains "N MAIN ST" ThoroughfareTrailingType will contain "ST".

av.ThoroughfarePostDirection

The postfix directional contained within the Thoroughfare field. E.g. if Thoroughfare contains "MAIN ST N" ThoroughfarePostDirection will contain "N".

av.DependentThoroughfare

The dependent street or block data element within a country; e.g. UK Dependent Street.

av.DependentThoroughfarePreDirection

The prefix directional contained within the DependentThoroughfare field. E.g. if DependentThoroughfare contains "N MAIN ST" DependentThoroughfarePreDirection will contain "N".

av.DependentThoroughfareLeadingType

The leading thoroughfare type indicator within the DependentThoroughfare field. E.g. if DependentThoroughfare contains "RUE DE LA GARE" DependentThoroughfareLeadingType will contain "RUE".

av.DependentThoroughfareName

The name indicator within the DependentThoroughfare field. E.g. if DependentThoroughfare contains "N MAIN ST" DependentThoroughfareName will contain "MAIN".

av.DependentThoroughfareTrailingType

The trailing thoroughfare type indicator within the DependentThoroughfare field. For instance, if DependentThoroughfare contains "N MAIN ST" DependentThoroughfareTrailingType will contain "ST".

av.DependentThoroughfarePostDirection

The postfix directional contained within the DependentThoroughfare field. E.g. if DependentThoroughfare contains "MAIN ST N" DependentThoroughfarePostDirection will contain "N".

av.Building

The descriptive name identifying an individual location.

av.BuildingLeadingType

The leading building type indicator within the Building field. E.g. if Building contains "BLOC C" BuildingLeadingType will contain "BLOC".

av.BuildingName

The name indicator within the Building field. E.g. if Building contains "WESTMINSTER HOUSE" BuildingName will contain "WESTMINSTER".

av.BuildingTrailingType

The trailing building type indicator within the Building field. E.g. if Building contains "WESTMINSTER HOUSE" BuildingTrailingType will contain "HOUSE".

av.Premise

The alphanumeric code identifying an individual location.

av.PremiseType

The leading premise type indicator within the Premise field. E.g. if Premise contains "Plot 7/7A" PremiseType will contain "Plot".

av.PremiseNumber

The alphanumeric indicator within the Premise field. For instance, if Premise contains "Plot 7/7A" PremiseNumber contains "7/7A".

av.SubBuilding

The secondary identifiers for a particular delivery point, e.g. "FLAT 1" or "SUITE 212".

av.SubBuildingType

The leading sub-building type indicator within the SubBuilding field. E.g. if SubBuilding contains "FLAT 1" SubBuildingType will contain "FLAT".

av.SubBuildingNumber

The alphanumeric indicator within the SubBuilding field. E.g. if SubBuilding contains "FLAT 1" SubBuildingNumber will contain "1".

av.SubBuildingName

The descriptive name within the SubBuilding field. E.g. if SubBuilding contains "BASEMENT FLAT" SubBuildingName will contain "BASEMENT FLAT".

av.PostalCode

The complete postal code for a particular delivery point.

av.PostalCodePrimary

The primary postal code used for a particular country; e.g. USA Zip, Canadian Postcode or Indian PINcode.

av.PostalCodeSecondary

Secondary postal code information; e.g., USA Zip Plus 4.

av.Organization

The business name associated with a particular delivery point.

av.OrganizationName

The name indicator within the Organization field. E.g. if Organization contains 'Loqate Inc" OrganizationName will contain "Loqate", if a sufficient level of parsing detail exists for the country.

av.OrganizationType

The trailing type indicator contained within the Organization field. E.g. if Organization contains "Loqate Inc" OrganizationType will contain "Inc", if a sufficient level of parsing detail exists for the country.

av.PostBox

The type indicator contained within the PostBox field. E.g. if PostBox contains "PO BOX 1234" PostBoxType will contain "PO BOX", if a sufficient level of parsing detail exists for the country.

av.PostBoxNumber

The alphanumeric indicator within the PostBox field. E.g. if PostBox contains "PO BOX 1234" PostBoxNumber will contain "1234", if a sufficient level of parsing detail exists for the country.

av.Latitude

The WGS 84 latitude in decimal degrees format.

av.Longitude

The WGS 84 longitude in decimal degrees format.

av.DeliveryAddress

The full address minus the Organization, Locality hierarchy, AdministrativeArea hierarchy and PostalCode hierarchy fields, correctly formatted for mailing in the relevant country, including line breaks specified using the AddressLineSeparator option.

av.Geodistance

The possible radius in meters of Geocoding results that have been calculated as the average of multiple points.

av.Contact

The contact name.

av.Function

The function or job title.

av.Department

Organizational department information.

av.Unmatched

Any words that could not be matched to a particular address component.

avverify.amas.DPID

Delivery Point Identifier: a unique 8-digit number which is assigned for every new address to the source address database

avverify.amas.FloorType

Type of floor or level

avverify.amas.FloorNumber

Floor or level number (which can include alpha characters)

avverify.amas.LotNumber

Allotment number

avverify.amas.PostBoxNum

Postal delivery number if the address is a postal delivery type

avverify.amas.PostBoxNumberPrefix

Postal delivery number prefix related to the postal delivery number

avverify.amas.PostBoxNumberSuffix

Postal delivery number suffix related to the postal delivery number

avverify.amas.PrimaryPremise

Thoroughfare number for a property (first number in a property ranged address)

avverify.amas.PrimaryPremiseSuffix

Suffix for the thoroughfare number

avverify.amas.SecondaryPremise

Second thoroughfare number (only used if the property has a ranged address. For example, 23-25)

avverify.amas.SecondaryPremiseSuffix

Suffix for the second thoroughfare number

avverify.amas.PreSortZone

Also known as Barcode Sort Plan (BSP) number. One of 54 individual sort regions around Australia. To qualify for Australia Post's PreSort Letters Service, letters must be sorted based on this number.

avverify.amas.PrintPostZone

Also known as a PreSort Indicator. To qualify for Australia Post's Print Post Service, letters must be sorted based on this number.

avverify.amas.Barcode

Barcode based on the DPID

avverify.amas.PrimaryAddressLine

Primary address line in standardized format

avverify.amas.SecondaryAddressLine

Secondary address line in standardized format

avverify.cass.AutoZoneIndicator

Automated Zone Indicator, where

• A – Carrier route sort rates apply. Merge allowed.

• B – Carrier route sort rates apply. Merge not allowed.

• C – Carrier route sort rates do not apply. Merge allowed.

• D – Carrier route sort rates do not apply. Merge not allowed.

avverify.cass.CarrierRoute

Carrier route code assigned to a mail delivery or collection route within a 5-digit ZIP Code, also referred to as CRID. There are 5 types:

• B – PO Box

• H – Highway contract

• R – Rural route

• C – City delivery

• G – General delivery

avverify.cass.CMRAIndicator

Indicates whether the address is associated with a Commercial Mail Receiving Agency(CMRA).

• Y – Address found in the table

• N – Address not found in the table

• blank – Address not presented to the table

avverify.cass.CongressionalDistrict

The congressional district to which the address belongs

avverify.cass.DefaultFlag

A value of "Y" indicates that the record matched to a high rise default, rural route default, or street default record in the ZIP+4 file.

avverify.cass.DeliveryPointBarCode

3-digit code which consists of the 2-digit delivery point code and 1-digit check digit.This is used to create the 12-digit POSTNET barcode which consists of the 5-digit ZIP Code, 4-digit ZIP+4 addon code, and this 3-digit code.

avverify.cass.DPVConfirmedIndicator

Indicates the deliverability of the address using one of the following values:

• Y – Confirmed

• N – Not confirmed

• S – Confirmed after dropping the subbuilding number

• D – Premise number confirmed but subbuilding number is missing

• blank – The address was not submitted for DPV confirmation.

avverify.cass.DPVFootnotes

Delivery Point Validation footnotes. This field is used with the DPVConfirmedIndicator field determine the input address' validity and deliverability.

• 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

• CC – Address is a deliverable address after dropping the subbuilding number from the input address

• F1 – Address matched to a military address

• G1 – Address matched to a general delivery address

• 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

• RR – Address matched to CMRA and PMB designator is present

• R1 – Address matched to CMRA but PMB designator is not present

• U1 – Address matched to a unique ZIP Code

avverify.cass.eLOTCode

eLOT directional indicator. See the eLOTNumber field for additional information. Values:

• A – ascending

• D – descending

avverify.cass.eLOTNumber

A 4-digit sequence number for eLOT (Enhanced Line of Travel). This number combined with the eLOTCode field is used in mail sorting. eLOT processing may be used by mailers to qualify for enhanced carrier route presort discounts.

avverify.cass.EWSFlag

A value of "Y" indicates that the address matched a record in the EWS (Early Warning System) file, thus resulting in a ZIP+4 no match

avverify.cass.FalsePositiveIndicator

The False Positive table flags the False Positive addresses. This flag determines whether a mailing list is being generated or created during validation. The USPS does not allow creating a mailing list through DPV certification.

• Y – Address was found in the table

• N – Address was not found in the table

• blank – Address was not presented to the table

avverify.cass.FIPSCountyCode

A 5-digit FIPS (Federal Information Processing Standard) code which uniquely identifies counties.

avverify.cass.Footnotes

Footnote string

• A – ZIP corrected

• B – City/State corrected

• C – Invalid City/State/ZIP

• D – No ZIP assigned

• E – ZIP assigned for multiple response

• F – No ZIP available

• G – Part of firm moved to address

• H – Subbuilding number missing

• I – Insufficient/incorrect data

• J – Dual input

• K – Multiple results caused by cardinal rule

• L – Delivery address component added/deleted/changed

• M – Street name spelling changed

• N – Delivery address was standardized

• O – Low +4 tie-breaker (multi-response)

• P – Better delivery address exists

• Q – Unique zipcode

• R – No match due to EWS (Early Warning System)

• S – Invalid secondary number

• T – Multiple results caused by magnet rule

• U – Unofficial PO name

• V – Unverifiable city/state

• W – Small town default

• X – Unique ZIP code generated

• Y – Military match

• Z – ZIP move match

avverify.cass.LACSLinkCode

Code returned by LACSLink after querying the LACSLink database.

• A – The input address matched to a record in the LACSLink database. A new address could be furnished.

• 00 – The input address could not be matched to a record in the LACSLink®database. A new address could not be furnished.

• 14 – The input record matched to a record in the LACSLink database. The new address could not be converted to a deliverable address.

• 92 – The input address matched to a LACSLink record but the input address had a subbuilding number and the LACSLink record did not.

avverify.cass.LACSLinkIndicator

Indicator returned by LACSLink after querying the LACSLink database.

• Y – The input address matched to a record in the LACSLink database.

• S – The input address matched to a LACSLink record but the input address had a subbuilding number and the LACSLink record did not.

• N – The input address could not be matched to a record in the LACSLink database. A new address could not be furnished.

• F – A false positive record was detected

avverify.cass.LACSStatus

A value of "L" indicates that the input address matched an entry in the Locatable Address Conversion Service database and the input address has been converted from a rural-style address to a city-style address.

avverify.cass.NoStatIndicator

Indicates the address is not receiving delivery, and the address is not counted as a possible delivery. These addresses are not receiving delivery because 1) delivery has not been established; 2) customer receives mail as a part of a drop; or 3) the address is no longer a possible delivery because the carrier destroys or returns all of the mail.

• Y – Address was found in the table

• N – Address was not found in the table

• blank – Address was not presented to the table

avverify.cass.PMBNumber

Parsed PMB number following the PMB designator

avverify.cass.PMBType

Parsed Private Mailbox (PMB) designator

avverify.cass.PrimaryAddressLine

Primary delivery address line. This can include any of the following:

• Premise Number

• Thoroughfare Name

• Thoroughfare Predirection

• Thoroughfare Postdirection

• Thoroughfare Trailing Type

• Subbuilding Number

• PO BOX

avverify.cass.RecordType

Record type of address that is confirmed as a valid delivery address. Values:

• S – Street

• P – PO Box

• R – Rural route

• H – Highrise

• F – Firm

• G – General delivery

avverify.cass.ReturnCode

• 10 – Invalid input address

• 11 – Invalid 5-digit ZIP Code

• 12 – Invalid state abbreviation code

• 13 – Invalid city name

• 21 – No match found

• 22 – Multiple responses were found and more specific information is required to select a single or default response

• 31 – A single matching address was found

• 32 – An address was found, but a more specific address could be found with more information

avverify.cass.ResidentialDelivery

This field indicates whether the input address is a residential address or a business address. Values:

• Y – residential

• N – business

• blank – invalid address

Note: This field is only available if RDI data pack is installed together with CASS.

avverify.cass.SecondaryAddressLine

Secondary delivery address line (if present).

avverify.cass.SUITELinkFootnote

Code returned by SuiteLink after querying the SuiteLink database. Values:

• A – The input address matched to a record in the SuiteLink database. An improved business address could be furnished.

• 00 – The input address could not be matched to a record in the SuiteLink database.

avverify.cass.VacantIndicator

Indicates that the delivery point was active in the past, but is currently vacant (in most cases, unoccupied over 90 days) and is not receiving deliveries. Values:

• Y – Address was found in the table

• N – Address was not found in the table

• blank – Address was not presented to the table

avverify.serp.SerpStatusEx

V (Valid)

C (Correctable): Correctable fields will have been corrected to their right values in the output.

N (Invalid)

avverify.serp.Questionable

QR (for "Questionable-Rural")

QU (for "Questionable-Urban")

Empty - the address is not questionable.

avverify.serp.DeliveryInstallationAreaName

Station/Postal Installation Area Name

avverify.serp.DeliveryInstallationType

Station/Postal Installation/Outlet Type

avverify.serp.DeliveryInstallationQualifierName

Name of the Postal Installation

avverify.serp.RouteType

The type of a Route Address: Rural Route, Military Route etc.

avverify.serp.RouteNumber

Identifies Route Number for a Route Address

avverify.serp.AdditionalContentType

Contains Site Or Compartment Specifier

avverify.serp.AdditionalContentNumber

Contains Site or Compartment Number