Support DESK

Follow

Address Fields

Loqate’s address structure is based on the OASIS Extensible Address Language (xAL) version 2.0, adapted to suit a flattened record structure rather than XML, and with changes to better suit customer expectations.

Some countries have more complex addressing structures than others. As such, the use of individual fields will vary based on the input country and the available reference data. The following fields are recognized, [in] designates a field that can be used on input, [out] designates a field that may be present on output, and [in, out] designates that a field can be used for both input and output:

Atomic Fields

Atomic fields are always populated and verified when appropriate.

Address [in,out]

This field holds the full address, correctly formatted for mailing in the relevant country, including line breaks specified using the AddressLineSeparator option.

Address1, Address2, …, Address8 [in,out]

These fields can be used to specify input address line data, and on output will contain the correctly formatted address for mailing in the relevant country, split into individual address lines.

DeliveryAddress [in,out]

This field holds 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.

DeliveryAddress1, DeliveryAddress2, …, DeliveryAddress8 [in,out]

These fields contain the individual lines contained within the DeliveryAddress field.

Country [in]

This field is used to supply the country name or code (ISO 3166 2-character country code and ISO 3166 3-character country code).

CountryName [out]

This field holds the ISO 3166 official country name.

ISO3166-2 [out]

This field holds the ISO 3166 2-character country code.

ISO3166-3 [out]

This field holds the ISO 3166 3-character country code.

ISO3166-N [out]

This field holds the ISO 3166 3-digit numeric country code.

SuperAdministrativeArea [in,out]

This field holds the largest geographic data element within a country.

AdministrativeArea [in,out]

This field holds the most common geographic data element within a country. For instance, USA State, and Canadian Province.

SubAdministrativeArea [in,out]

This field holds the smallest geographic data element within a country. For instance, USA County.

Locality [in,out]

This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality.

DependentLocality [in,out]

This field holds a smaller population center data element, dependent on the contents of the Locality field. For instance, Turkish Neighborhood.

DoubleDependentLocality [in,out]

This field holds the smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For instance, UK Village.

Thoroughfare [in,out]

This field holds the most common street or block data element within a country. For instance, USA Street.

DependentThoroughfare [in,out]

This field holds the dependent street or block data element within a country. For instance, UK Dependent Street.

Building [in,out]

This field contains the descriptive name identifying an individual location, should one exist.

Premise [in,out]

This field contains the alphanumeric code identifying an individual location, should one exist.

SubBuilding [in,out]

This field contains the secondary identifiers for a particular delivery point. For instance, “FLAT 1” or “SUITE 212”.

PostalCode [in,out]

This field contains the complete postal code for a particular delivery point, should such detail be able to be determined.

PostalCodePrimary [out]

This field contains the primary postal code used for a particular country. For instance, USA Zip, Canadian Postcode, Indian PINcode.

PostalCodeSecondary [out]

This field contains 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 instance, USA Zip Plus 4.

Organization [in,out]

This field contains the business name associated with a particular delivery point, should one exist.

PostBox [in,out]

This field contains the post box for a particular delivery point, should one exist.

Unmatched [out]

This field contains any words that could not be matched to a particular address component.

GeneralDelivery

This field is available when adding “SERP” to the Loqate engine. It identifies a General Delivery type address – Example value: GD

DeliveryInstallation

This field is available when adding “SERP” to the Loqate engine. It contains the Station Information to direct mail to the proper postal installation for non-civic addresses. Example value: STN A

Route

This field is available when adding “SERP” to the Loqate engine. It identifies a Route Address, such as Rural Route, Military Route. Example value: RR 6

AdditionalContent

This field is available when adding “SERP” to the Loqate engine. Sometimes a site specification and compartment is assigned for delivery to a rural address that does not have a civic address. Example value: SITE 6 COMP 10

Sub Fields

Sub Fields are populated when the level of parsing detail exists for the particular country. Sub Fields are verified when they are supported by the reference data for the particular country. Therefore they are not guaranteed to be populated or verified in the output.

For example, a Sub Field may be populated from the parsed input, but may not be able to be verified. Please check the associated Field Status to confirm.

Unmatched [out]

This field can hold any information in the input address fields that is unable to be parsed to a particular address field.

MatchRuleLabel [out]

Loqate Engine uses a set of rules to match the input with the reference data. Each rule is identified by a match rule label.
Please refer to the below links for more information regarding the Match Rules.

Contact [in,out]

This field can hold contact name information.

Function [in,out]

This field can hold function or job title information.

Department [in,out]

This field can hold organizational department information.

LocalityExtra [out]

This field is used to hold information that could be present along with the Locality. This information is not considered as part of the Postal authority data but is still necessary for parsing the address in order to obtain a complete delivery address. Available if a sufficient level of parsing detail exists within a particular country.
Example: 12 rue de la Gare, 75019 PARIS CEDEX, France. CEDEX will be considered as Locality Extra.

DependentLocalityName [in,out]

This field holds the name indicator within the DependentLocality field, should one exist. For instance, if DependentLocality contains “Dong Cheng Qu” DependentLocalityName contains “Dong Cheng” if a sufficient level of parsing detail exists for the particular country.

DependentLocalityType [in,out]

This field is used to hold the DependentLocality indicator within the DependentLocality field, should one exist. For instance, if DependentLocality contains “Dong Cheng Qu” DependentLocalityType contains “Qu” if a sufficient level of parsing detail exists for the particular country.

DoubleDependentLocalityName [in,out]

This field holds the name indicator within the DoubleDependentLocality field, should one exist. For instance, if DoubleDependentLocality contains “Xin Zhuang Zhen” DoubleDependentLocalityName contains “Xin Zhuang” if a sufficient level of parsing detail exists for the particular country.

DoubleDependentLocalityType [in,out]

This field is used to hold the DoubleDependentLocality indicator within the DoubleDependentLocality field, should one exist. For instance, if DoubleDependentLocality contains “Xin Zhuang Zhen” DoubleDependentLocalityType contains “Zhen” if a sufficient level of parsing detail exists for the particular country.

ThoroughfarePreDirection [in,out]

This field holds the prefix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfarePreDirection contains “N” if a sufficient level of parsing detail exists for the particular country.

ThoroughfareLeadingType [in,out]

This field holds the leading thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “RUE DE LA GARE” ThoroughfareLeadingType contains “RUE” if a sufficient level of parsing detail exists for the particular country.

ThoroughfareName [in,out]

This field holds the name indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfareName contains “MAIN” if a sufficient level of parsing detail exists for the particular country.

ThoroughfareTrailingType [in,out]

This field holds the trailing thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfareTrailingType contains “ST” if a sufficient level of parsing detail exists for the particular country.

ThoroughfarePostDirection [in,out]

This field holds the postfix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “MAIN ST N” ThoroughfarePostDirection contains “N” if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfarePreDirection [in,out]

This field holds the prefix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “N MAIN ST” DependentThoroughfarePreDirection contains “N” if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfareLeadingType [in,out]

This field holds the leading thoroughfare type indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “RUE DE LA GARE” DependentThoroughfareLeadingType contains “RUE” if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfareName [in,out]

This field holds the name indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “N MAIN ST” DependentThoroughfareName contains “MAIN” if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfareTrailingType [in,out]

This field holds the trailing thoroughfare type indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “N MAIN ST” DependentThoroughfareTrailingType contains “ST” if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfarePostDirection [in,out]

This field holds the postfix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “MAIN ST N” DependentThoroughfarePostDirection contains “N” if a sufficient level of parsing detail exists for the particular country.

BuildingLeadingType [in,out]

This field holds the leading building type indicator within the Building field, should one exist. For instance, if Building contains “BLOC C” BuildingLeadingType contains “BLOC” if a sufficient level of parsing detail exists for the particular country.

BuildingName [in,out]

This field holds the name indicator within the Building field, should one exist. For instance, if Building contains “WESTMINSTER HOUSE” BuildingName contains “WESTMINSTER” if a sufficient level of parsing detail exists for the particular country.

BuildingTrailingType [in,out]

This field holds the trailing building type indicator within the Building field, should one exist. For instance, if Building contains “WESTMINSTER HOUSE” BuildingTrailingType contains “HOUSE” if a sufficient level of parsing detail exists within a particular country.

PremiseType [in,out]

This field contains the leading premise type indicator within the Premise field, should one exist. For instance, if Premise contains “Plot 7/7A” PremiseType contains “Plot” if a sufficient level of parsing detail exists within a particular country.

PremiseNumber [in,out]

This field contains 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.

PremiseExtra [out]

This field is used to hold information that could be present as part of the Premise field. This information is not considered as part of the Postal authority data but is still necessary for parsing the address in order to obtain a complete delivery address. Available if a sufficient level of parsing detail exists within a particular country.
Example: In French address, the Premise number could be followed by words bis and ter which will be considered as Premise Extra .
25 bis rue Emile Zola, 91190 GIF SUR YVETTE, France. Bis will be considered as PremiseExtra.

SubBuildingType [in,out]

This field contains the leading sub-building type indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains “FLAT 1” SubBuildingType contains “FLAT” if a sufficient level of parsing detail exists within a particular country.

SubBuildingLeadingType [in,out]

This field contains the sub-building type indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains “FLAT 1″ SubBuildingLeadingType contains “FLAT” if a sufficient level of parsing detail exists within a particular country.

SubBuildingNumber [in,out]

This field contains the alphanumeric indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains “FLAT 1” SubBuildingNumber contains “1” if a sufficient level of parsing detail exists within a particular country.

SubBuildingName [in,out]

This field contains the descriptive name within the SubBuilding field. For instance, if SubBuilding contains “BASEMENT FLAT” SubBuildingName contains “BASEMENT FLAT”.

OrganizationName [in,out]

This field contains the name indicator within the Organization field, should one exist. For instance, if Organization contains ‘Loqate Inc” OrganizationName contains “Loqate” if a sufficient level of parsing detail exists for the particular country.

OrganizationType [in,out]

This field contains the trailing type indicator contained within the Organization field, should one exist. For instance, if Organization contains “Loqate Inc” OrganizationType contains “Inc” if a sufficient level of parsing detail exists for the particular country.

PostBoxType [in,out]

This field contains the type indicator contained within the PostBox field, should one exist. For instance, if PostBox contains “PO BOX 1234” PostBoxType contains “PO BOX” if a sufficient level of parsing detail exists for the particular country.

PostBoxNumber [in,out]

This field contains the alphanumeric indicator within the PostBox field, should one exist. For instance, if PostBox contains “PO BOX 1234” PostBoxNumber contains “1234” if a sufficient level of parsing detail exists for the particular country.

DeliveryInstallationAreaName

This field is available when adding “SERP” to the Loqate engine. It holds Station/Postal Installation Area Name.

DeliveryInstallationType

This field is available when adding “SERP” to the Loqate engine. It contains Station/Postal Installation/Outlet Type. Examples: STN, RPO, LCD.

DeliveryInstallationQualifierName

This field is available when adding “SERP” to the Loqate engine. It holds Name of the Postal Installation. Example: A, TOUR D/L BOURSE, 1

RouteType

This field is available when adding “SERP” to the Loqate engine. It identifies the type of a Route Address: Rural Route, Military Route etc. Examples: RR, MR

RouteNumber

This field is available when adding “SERP” to the Loqate engine. It identifies Route Number for a Route Address: 1, 2 etc.

AdditionalContentType

This field is available when adding “SERP” to the Loqate engine. It assigned Site Or Compartment Specifier: Examples: CONC, COMP, S, G.

AdditionalContentNumber

This field is available when adding “SERP” to the Loqate engine. It contains Site or Compartment Number: 1,2 etc.

 

Was this article helpful?
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.