Address Verification

The Address Verification processor (AV) is used to verify and standardize address data from any country. It also provides geocoding.

Note: If the processor has not been correctly installed it will still run but all the output fields will be left blank, except for av.Accuracy Code, which will have a value of -1.0.

Use

Configuration

Note: This processor always appears with a re-run marker, indicating that it will be completely re-executed each time the process is run, regardless of whether or not its configuration has changed. This will also mean that processors that are downstream of the processor will need to be rerun. This is because there may be changes made outside of the EDQ application that could lead to different results on subsequent executions.

Inputs

Note: The Input attribute mappings are used as clues by the processor as to which Input attributes may contain specific data types, according to the initial structure of the address data. It is not normally necessary to parse addresses fully into all the different Input attributes before putting data through Address Verification. In many cases, it is sufficient to simply add address data to the Input address lines (as long as a country is provided), as the Address Verification processor itself will internally parse addresses before matching them against country-specific reference data. However, if addresses are well structured, more effective verification results may be seen if the corresponding input attribute mappings are used (for example, if an Input attribute normally contains postal codes, it is best to map it to the Postal Code input attribute rather than simply mapping it in as an address line.)

Note: The Country input must be populated with a country name or code. Without it, Address Verification cannot verify an address or produce an Accuracy Code.

Options

Option	Description	Settings
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.

Outputs

Flags

Output field	Description
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 post box for a particular delivery point, should one exist.
av.PostBoxType	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.

Note: If the Returned field status flag? option on the Options tab of the processor is set to Yes, an additional flag will generated for each output attribute, with a numeric value indicating the verification status of each one.

AccuracyCode

GeoAccuracy

Execution

Results Browsing

The Address Verification processor presents no summary statistics on its processing.

Value	Description	Settings
Geocoding Status	Indicates whether a Geocode for the address has been found.	P: Point - A single geocode was found matching the input address I: Interpolated - A geocode was interpolated from the input address's 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	Indicates the geographical accuracy of the Geocode.	5: Delivery Point (PostBox or SubBuilding) 4: Premise (Premise or Building) 3: Thoroughfare 2: Locality 1: Administrative Area 0: None

In the Data view, each input attribute is shown with the output attributes to the right.

Output Filters

Example

The below screenshot shows the output of the Address Verification processor on some sample addresses. In this case, the Results Browser has chosen to Show flags in order to see the output AccuracyCode and other flags:

Flag name	Details
av.AccuracyCode	A code that indicates how accurately each address has been identified and matched. Note: For the multiple output options (Verify: Allow Multiple Results and Search), an Accuracy Code is returned for each result found.
av.ResultCount	Number of addresses returned. Always "1" for Verify mode.
av.MatchScore	The match between the input and the closest reference match, expressed as a percentage. This is extracted from the Accuracy code.
av.GeoAccuracy	A code that indicates whether one or more Geocodes associated with the address have been identified.

Code	Description
0	Not Applicable: Field is not applicable to return field status.
1	Verified No Change: Field has been verified using relevant reference data, no changes were needed.
2	Verified Alias Change: Field has been verified using relevant reference data, an alias change was made during parsing (see 7: Identified Alias).
3	Verified Small Change: Field has been verified using relevant reference data, a small spelling change was made.
4	Verified Large Change: Field has been verified using relevant reference data, a large spelling change was made.
5	Added: Field has been added using relevant reference data.
6	Identified No Change: Field has been identified using relevant lexicon data, no changes were needed. e.g. an input value of "PO Box 1234" may be identifiable as a PostBox, but if it is unable to be verified then status 6 will be returned.
7	Identified Alias: Field has been identified using relevant lexicon data, an alias change was made. e.g. an input value of ‘Avnue’ may be identifiable as an alias to the ThoroughfareType ‘Ave’.
8	Identified Context: Field has been identified using relevant context rules. e.g. an input Address of "123 sdovnsdv San Bruno CA USA" may identify the word "sdovnsdv" as a Thoroughfare, but only because of the context in which it appears (after an identifiable Premise Number, and before an identifiable Locality).
9	Empty: Field is empty.
10	Unrecognized: Field is unrecognized.

Execution Mode	Supported
Batch	Yes
Real-Time Monitoring	Yes
Real-Time Response	Yes