Loqate Node Inputs and Outputs

Input Fields

Most of the Loqate node input and output fields are identical to the fields in the Loqate software, as described in their documentation. The only exception is the output field AccuracyCode. See the description of that field in Output Fields.

Field Name Description
Address The full address.
Address1 Address line 1
Address2 Address line 2
Address3 Address line 3
Address4 Address line 4
Address5 Address line 5
Address6 Address line 6
Address7 Address line 7
Address8 Address line 8
AdministrativeArea The most common geographic data element within a country. For instance, USA State, and Canadian Province.
Building The descriptive name identifying an individual location, should one exist.
Contact The name of the person of contact.
Country The country name or code.
DeliveryAddress The full delivery address.
DeliveryAddress1 Delivery address line 1
DeliveryAddress2 Delivery address line 2
DeliveryAddress3 Delivery address line 3
DeliveryAddress4 Delivery address line 4
DeliveryAddress5 Delivery address line 5
DeliveryAddress6 Delivery address line 6
DeliveryAddress7 Delivery address line 7
DeliveryAddress8 Delivery address line 8
Department The department name.
DependentLocality Contains a smaller population center data element, dependent on the contents of the Locality field. For instance, Turkish Neighborhood.
DependentThoroughfare The dependent street or block data element within a country. For instance, UK Dependent Street.
DoubleDependentLocality The smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For example, UK Village.
Function A function or job title.
ID This field passes through the input and output unchanged.
Locality The most common population center data element within a country. For example, USA City or Canadian Municipality.
Organization The business name associated with a particular delivery point.
PostalCode The complete postal code for a particular delivery point, if the detail can be determined.
PostBox The post box for a particular delivery point.
Premise The alphanumeric code identifying an individual location.
SubAdministrativeArea The smallest geographic data element within a country. For example, USA County.
SubBuilding The secondary identifiers for a particular delivery point. For example, FLAT 1 or SUITE 212.
SubBuildingFloor The secondary identifier for the building floor. For example, 2nd Floor.
SuperAdministrativeArea The largest geographic data element within a country.
Thoroughfare The most common street or block data element within a country. For example, USA Street.

Output Fields

Field Name Description
AccuracyCode See AVC.
AVC Address Verification Code (AVC) - This field assesses how well Loqate is able to parse, match, and verify the input address. It contains multiple components which rate the success at various stages of the verification process. Full details can be found on www.loqate.com under Field Descriptions > Address Verification Code.
Address The full address, correctly formatted for mailing in the relevant country
Address1 Address Line 1
Address2 Address Line 2
Address3 Address Line 3
Address4 Address Line 4
Address5 Address Line 5
Address6 Address Line 6
Address7 Address Line 7
Address8 Address Line 8
AddressFormat This field contains the fields used for the Address field.
AddressKey Available with the Loqate UK DSEQBRD data pack. See United Kingdom-Specific Output Fields.
AdministrativeArea The most common geographic data element within a country. For example, USA State or Canadian Province.
AdministrativeAreaName The name indicator within the field. For example, Oklahoma when the input is Oklahoma City.
AdministrativeAreaTrailingType The trailing AdministrativeArea type. For example, City when the AdministrativeArea is Oklahoma City.
AdministrativeAreaType The trailing AdministrativeArea type. For example, for Oklahoma City the output is City.
AQI The Address Quality Index (AQI) provides a view of the overall address quality.
Bolignummer The utility unit number. The number consists of a letter followed by four numbers. Used for Norway only. For example, H0001 or K0032.
BoxBagLobbyName A box lobby name or New Zealand Post shop name. Used for New Zealand. For example, NEWMARKET POSTSHOP or MAUNGATAPERE POSTCENTRE.
BranchName The branch name for the Department field. Used for Canada only. For example, Fisheries and Oceans or Ottawa District Office.
Building The descriptive name identifying an individual location, if one exists.
BuildingLeadingType The leading building type indicator in the field. For example, if Building contains BLOC Cthen the output is BLOC, if a sufficient level of parsing detail exists for the country.
BuildingName The name indicator within the field. For example, for WESTMINSTER HOUSE the output is WESTMINSTER, if a sufficient level of parsing detail exists for the particular country.
BuildingTrailingType The trailing building type indicator within the field. For example, for WESTMINSTER HOUSE the output is HOUSE, if a sufficient level of parsing detail exists within a particular country.
BuildingType The building type. For example, Flat or Place.
Contact Parsed contact information about the recipient.
CountryName The official country name.
DeliveryAddress The full address without the Organization, Locality, AdministrativeArea, and PostalCode hierarchy fields, correctly formatted for mailing in the relevant country.
DeliveryAddress1 DeliveryAddress Line 1
DeliveryAddress2 DeliveryAddress Line 2
DeliveryAddress3 DeliveryAddress Line 3
DeliveryAddress4 DeliveryAddress Line 4
DeliveryAddress5 DeliveryAddress Line 5
DeliveryAddress6 DeliveryAddress Line 6
DeliveryAddress7 DeliveryAddress Line 7
DeliveryAddress8 DeliveryAddress Line 8
DeliveryAddressFormat This field includes the fields used to construct the DeliveryAddress field.
DeliveryInstallationAreaName The name of a village, town, municipality, city, and metropolitan area that forms part of a delivery installation name. Used for Canada only.
DeliveryInstallationQualifierName When more than one delivery installation serves an area described by the DeliveryInstallationAreaName. The qualifier name identifies the delivery installation. Used for Canada only.
DeliveryInstallationType An abbreviation that represents the type of installation. Used for Canada only. For example, PO for Post Office or BDP for Bureau De Poste.
Department Parsed department information about the recipient.
DependentLocality This field contains a smaller population center data element, dependent on the contents of the field. For example, Turkish Neighborhood.
DependentLocalityLeadingType The leading dependent locality type. For example, Rancheria San Jose Cacahuatepec where the DependentLocality is Ciudad Renacimiento.
DependentLocalityName The name within the field. For example, for Dong Cheng Qu the name is Dong Cheng, if a sufficient level of parsing details exists for the country.
DependentLocalityType The locality type indicator. For example, for Dong Cheng Qu the type is Qu, if a sufficient level of parsing details exists for the country.
DependentThoroughfare The dependent street or block data element within a country. For example, UK Dependent Street.
DependentThoroughfareLeadingType The leading thoroughfare type indicator within the field. For example, for RUE DE LA GARE the output is RUE, if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfareName The name indicator within the field. For example, for N MAIN ST the output is MAIN, if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfarePostDirection The postfix directional contained within the field. For example, for MAIN ST N the output is N if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfarePreDirection The prefix directional contained within the field. For example, for N MAIN ST the output is N, if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfareTrailingType The trailing thoroughfare type indicator within the field. For example,for N MAIN ST the output is ST, if a sufficient level of parsing detail exists for the particular country.
DoubleDependentLocality The smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For example, UK Village.
DoubleDependentLocalityName The name of a DoubleDependentLocality. For example, if the locality is Xin Zhuang Zhen then the name is Xin Zhuang.
DoubleDependentLocalityType The type of a DoubleDependentLocality.
DPS Available with the Loqate UK DSEQBRD data pack. See United Kingdom-Specific Output Fields.
DPSChecksum Available with the Loqate UK DSEQBRD data pack. See United Kingdom-Specific Output Fields.
Function Parsed function information about the recipient.
GeoAccuracy The geocoding accuracy code generated by Loqate.
GeoDistance Records the radius of accuracy in meters, giving an indication of the likely maximum distance between the given geocode and the physical location.
HyphenClass A code of A, B, or C that identifies how a hyphen in a premise is handled.
ID This field is passed through to the output unchanged.
ISO3166-2 The ISO 3166 2-character country code.
ISO3166-3 The ISO 3166 3-character country code.
ISO3166-N The ISO 3166 3-digit numeric country code.
Latitude If geocoding is enabled, licensed, and geocoding data is found, this is the latitude of the address.
Locality The most common population center data element within a country. For example, USA City or Canadian Municipality.
LocalityExtra Information that is used when parsing the Locality but that is not a part of the official postal data.
LocalityName The name indicator within the Locality field. For example, Jeju-Si is the Locality and Jeju is the LocalityName.
LocalitySpecial A combination of Locality and LocalityExtra that captures specific locality details essential for accurate parsing and delivery. For example, for the address 12 rue de la Gare, 75019 PARIS CEDEX, France, Paris is the primary locality and CEDEX is the additional information necessary for a complete delivery address.
LocalityTrailingType The field trailing type indicator for Locality. For example, Dist..
LocalityType The field type indicator for Locality. For example, Da'an Dist. is the locality and Dist. is the type.
Longitude If geocoding is enabled, licensed, and geocoding data is found, this is the longitude of the address.
MakaniNumber The Makani number is a 10-digit number that provides the exact location of the building entrance. For United Arab Emirates. For example, 3000595279.
Organization The business name associated with a particular delivery point.
OrganizationKey Available with the Loqate UK DSEQBRD data pack. See United Kingdom-Specific Output Fields.
OrganizationName The name indicator within the field. For example, for Loqate Inc the output is Loqate, if a sufficient level of parsing detail exists for the particular country.
OrganizationTrailingType This field contains the trailing type indicator within the Organization field. For example, Corp. or Inc.
OrganizationType The trailing type indicator contained within the field. For example for Loqate Inc the output is Inc, if a sufficient level of parsing detail exists for the particular country.
PostalCode The complete postal code for a particular delivery point, if this detail can be determined.
PostalCodePrimary The primary postal code used for a particular country. For example, USA ZIP, Canadian Postcode, or Indian PINcode.
PostalCodeSecondary This field contains secondary postal code information, if used in a particular country and if this detail can be determined and reference data is available. For instance, USA ZIP Plus 4.
PostBox The post box for a particular delivery point.
PostBoxNumber The alphanumeric indicator within the field. For example, for PO BOX 1234 the out is 1234, if a sufficient level of parsing detail exists for the particular country.
PostBoxType The type indicator contained within the field. For example, for PO BOX 1234 the output is PO BOX, if a sufficient level of parsing detail exists for the particular country.
Premise The alphanumeric code identifying an individual location.
PremiseExtra Parsed but unmatched information from a premises.
PremiseNumber The alphanumeric indicator within the field. For example, for Plot 7/7A the output is 7/7A, if a sufficient level of parsing detail exists within a particular country.
PremiseType This type indicator within the field. For example, for Plot 7/7A the PremiseType is Plot.
RouteNumber A number that identifies the delivery mode. For Canada only.
RouteType A code that identifies the type of route service. For Canada only. For example, RR is the code for Rural Route.
Sequence When multiple addresses are included in a request, this counter shows the order of the addresses from the input. For example, 7 represents the 7th address in the input request.
ShortAddressCode A short address that consists four letters and four numbers. For Saudi Arabia only. For example, RGSA3808.
SubAdministrativeArea The smallest geographic data element within a country. For instance, USA County.
SubBuilding The secondary identifiers for a particular delivery point. For instance, FLAT 1 or SUITE 212.
SubBuildingDoor The secondary identifiers for a particular delivery point. For example, PUERTA D.
SubBuildingFloor The parsed floor information for a particular delivery point. For example, L7 or Fl 12.
SubBuildingLeadingType The type component of a SubBuilding field. For example, if the SubBuilding is FLAT 1 then the leading type is FLAT.
SubBuildingName The descriptive name within the field. For example, for BASEMENT FLAT the SubBuildingName contains BASEMENT FLAT.
SubBuildingNumber The alphanumeric indicator within the field. For example, for FLAT 1 the SubBuildingNumber is “1, if a sufficient level of parsing detail exists within a particular country.
SubBuildingStaircase The secondary identifiers for a particular delivery point. For example, PUERTA D.
SubBuildingType The type indicator within the field. For example, for FLAT 1 the type is FLAT, if a sufficient level of parsing detail exists within the country.
SuperAdministrativeArea The largest geographic data element within a country.
Thoroughfare The most common street or block data element within a country. For instance, USA Street.
ThoroughfareLeadingType The leading thoroughfare type indicator within the field. For example, for RUE DE LA GARE the type is RUE, if a sufficient level of parsing detail exists for the particular country.
ThoroughfareName The name indicator within the field. For example, for N MAIN ST the name is MAIN, if a sufficient level of parsing detail exists for the particular country.
ThoroughfarePostDirection

The postfix directional contained within the field. For example, for MAIN ST N the direction is N, if a sufficient level of parsing detail exists for the particular country.
ThoroughfarePreDirection The prefix directional contained within the field. For example, for N MAIN ST the predirection is N, if a sufficient level of parsing detail exists for the particular country.
ThoroughfareTrailingType The trailing thoroughfare type indicator For example, for N MAIN ST the thoroughfare type is ST, if a sufficient level of parsing detail exists for the particular country.
ThoroughfareType The type of thoroughfare. For example, Road, St, or Rua.
TradCounty Available with the Loqate UK DSEQBRD data pack. See United Kingdom-Specific Output Fields.
TradNumber Available with the Loqate UK DSEQBRD data pack. See United Kingdom-Specific Output Fields.
UDPRN Available with the Loqate UK DSEQBRD data pack. See United Kingdom-Specific Output Fields.
Unmatched This field is used to enter unused input information.

 

United Kingdom-Specific Output Fields

The following fields are available only for United Kingdom (UK)-specific fields under the following conditions.

Field Name Description
AddressKey When used in conjunction with the OrganizationKey, it provides a unique reference number to every address on PAF. These keys are assigned by the Royal Mail.
DPS This is the UK Delivery Point Suffix, a unique reference value assigned to each delivery point in the UK.
DPSChecksum The UK Barcode Checksum value or UK DPS Barcode checksum value. Calculated from the Post Code and the DPS.
OrganizationKey When used in conjunction with the AddressKey, provides a unique reference number to every address on PAF. These keys are assigned by the Royal Mail.
TradCounty Traditional county name.
TradNumber Traditional county number.
UDPRN UK Delivery Point reference number. A unique reference number assigned to each delivery point in the UK.