Address fields in tLoqateAddressRow

Field name	Description
Address [in,out]	specifies the full mailing address in the relevant country.
Address1, Address2, ... Address12 [in,out]	specifies input data for the address line in the relevant country, split into individual address lines.
DeliveryAddress [out]	specifies the full address including line breaks without the Organization, Locality, AdministrativeArea and PostalCode fields.
DeliveryAddress1, DeliveryAddress2...DeliveryAddress12 [out]	specifies the individual lines contained within the DeliveryAddress field.
Country [in]	provides the country name or code.
CountryName [out]	provides the ISO 3166 official country name.
ISO3166-2 [out]	provides the ISO 3166 2-character country code.
ISO3166-3 [out]	provides the ISO 3166 3-character country code.
ISO3166-N [out]	provides the ISO 3166 3-digit numeric country code.
SuperAdministrativeArea [in,out]	provides the largest geographic data element within a country.
AdministrativeArea [in,out]	provides the most common geographic data element within a country. For example, USA State, and Canadian Province.
SubAdministrativeArea [in,out]	provides the smallest geographic data element within a country. For example, USA County.
Locality [in,out]	provides the most common population center data element within a country. For example, USA City, Canadian Municipality.
DependentLocality [in,out]	provides a smaller population center data element, dependent on the contents of the Locality field. For example, Turkish Neighborhood.
DoubleDependentLocality [in,out]	provides the smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For example, UK Village
Thoroughfare [in,out]	provides the most common street or block data element within a country. For example, USA Street.
DependentThoroughfare [in,out]	provides the dependent street or block data element within a country. For example, UK Dependent Street.
Building [in,out]	provides the descriptive name identifying an individual location, if such a name exists.
Premise [in,out]	provides the alphanumeric code identifying an individual location, if such a code exists.
SubBuilding [in,out]	provides the secondary identifiers for a particular delivery point. For example, "FLAT 1" or "SUITE 212".
PostalCode [in,out]	provides the complete postal code for a particular delivery point, if such detail can be determined.
PostalCodePrimary [out]	provides the primary postal code used for a particular country. For example, USA Zip, Canadian Postcode, Indian PINcode.
PostalCodeSecondary [out]	provides secondary postal code information, if used in a particular country and if such detail can be determined and reference data is available. For example, USA Zip Plus 4.
Organization [in,out]	provides the business name associated with a particular delivery point, if such a name exists.
PostBox [out]	provides the post box for a particular delivery point, if it exists.
Unmatched [out]	lists any words that could not be matched to a particular address component.
Latitude [out]	provides the WGS 84 latitude in decimal degrees format.
Longitude [out]	provides the WGS 84 longitude in decimal degrees format.
GeoAccuracy [out]	provides the GeoAccuracy code. For further information, see GeoAccuracy Code.
GeoDistance [out]	provides the radius of accuracy in meters, giving an indication of the likely maximum distance between the given geocode and the physical location.
AddressFormat [out]	provides the elements of the address. For example, if Address contains 805 Veterans Blvd Redwood City CA 94063-1734, AddressFormat contains Premise Thoroughfare Locality AdministrativeArea PostalCode.
DeliveryAddressFormat [out]	provides the elements of the delivery address. For example, if Address contains 805 Veterans Blvd Redwood City CA 94063-1734, DeliveryAddressFormat contains Premise Thoroughfare Locality AdministrativeArea PostalCode.
MatchRuleLabel [out]	provides the label of the match rule used to match the input with the reference data. For further information, see the match rule syntax.
Contact [in,out]	provides the contact name.
Function [in,out]	provides the function or job title.
Department [in,out]	provides the organizational department.
LocalityExtra [out]	provides information that could be as part of the Locality field. This information is not mandatory but is necessary to obtain a complete delivery address. For example in a French address: 12 rue de la Gare, 75019 PARIS CEDEX, France. CEDEX will be considered as Locality Extra.
DependentLocalityName [in,out]	provides the name indicator within the DependentLocality field. For example, 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]	provides the type indicator within the DependentLocality field. For example, if DependentLocality contains Dong Cheng Qu, DependentLocalityType contains Qu if a sufficient level of parsing detail exists for the particular country.
DoubleDependentLocalityName [in,out]	provides the name indicator within the DoubleDependentLocality field. For example, 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]	provides the type indicator within the DoubleDependentLocality field. For example, if DoubleDependentLocality contains Xin Zhuang Zhen, DoubleDependentLocalityType contains Zhen if a sufficient level of parsing detail exists for the particular country.
ThoroughfarePreDirection [in,out]	provides the prefix directional contained within the Thoroughfare field. For example, if Thoroughfare contains N MAIN ST, ThoroughfarePreDirection contains N if a sufficient level of parsing detail exists for the particular country.
ThoroughfareLeadingType [in,out]	provides the leading thoroughfare type indicator within the Thoroughfare field. For example, 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]	provides the name indicator within the Thoroughfare field. For example, if Thoroughfare contains N MAIN ST, ThoroughfareName contains MAIN if a sufficient level of parsing detail exists for the particular country.
ThoroughfareTrailingType [in,out]	provides the trailing thoroughfare type indicator within the Thoroughfare field. For example, if Thoroughfare contains N MAIN ST, ThoroughfareTrailingType contains ST if a sufficient level of parsing detail exists for the particular country.
ThoroughfarePostDirection [in,out]	provides the postfix directional contained within the Thoroughfare field. For example, if Thoroughfare contains MAIN ST N, ThoroughfarePostDirection contains N if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfarePreDirection [in,out]	provides the prefix directional contained within the DependentThoroughfare field. For example, if DependentThoroughfare contains N MAIN ST, DependentThoroughfarePreDirection contains N if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfareLeadingType [in,out]	provides the leading thoroughfare type indicator within the DependentThoroughfare field. For example, 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]	provides the name indicator within the DependentThoroughfare field. For example, if DependentThoroughfare contains N MAIN ST, DependentThoroughfareName contains MAIN if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfareTrailingType [in,out]	provides the trailing thoroughfare type indicator within the DependentThoroughfare field. For example, if DependentThoroughfare contains N MAIN ST, DependentThoroughfareTrailingType contains ST if a sufficient level of parsing detail exists for the particular country.
DependentThoroughfarePostDirection [in,out]	provides the prefix directional contained within the DependentThoroughfare field. For example, if DependentThoroughfare contains MAIN ST N, DependentThoroughfarePostDirection contains N if a sufficient level of parsing detail exists for the particular country.
BuildingLeadingType [in,out]	provides the leading building type indicator within the Building field. For example, if Building contains BLOC C, BuildingLeadingType contains BLOC if a sufficient level of parsing detail exists for the particular country.
BuildingName [in,out]	provides the name indicator within the Building field. For example, if Building contains WESTMINSTER HOUSE, BuildingName contains WESTMINSTER if a sufficient level of parsing detail exists for the particular country.
BuildingTrailingType [in,out]	provides the name indicator within the Building field. For example, if Building contains WESTMINSTER HOUSE, BuildingTrailingType contains HOUSE if a sufficient level of parsing detail exists for the particular country.
PremiseType [in,out]	provides the leading premise type indicator within the Premise field. For example, if Premise contains Plot 7/7A, PremiseType contains Plot if a sufficient level of parsing detail exists within a particular country.
PremiseNumber [in,out]	provides the leading premise type indicator within the Premise field. For example, if Premise contains Plot 7/7A, PremiseNumber contains 7/7A if a sufficient level of parsing detail exists within a particular country.
PremiseExtra [out]	provides information that could be as part of the Premise field. This information is not mandatory but is necessary to obtain a complete delivery address. For example in a French address: 12 bis rue de la Gare, 75019 PARIS, France. Bis will be considered as Locality Extra.
SubBuildingType [in,out]	provides the leading sub-building type indicator within the SubBuilding field. For example, if SubBuilding contains FLAT 1, SubBuildingType contains FLAT if a sufficient level of parsing detail exists within a particular country.
SubBuildingLeadingType [in,out]	provides the leading sub-building type indicator within the SubBuilding field. For example, if SubBuilding contains FLAT 1, SubBuildingLeadingType contains FLAT if a sufficient level of parsing detail exists within a particular country.
SubBuildingNumber [in,out]	provides the leading sub-building type indicator within the SubBuilding field. For example, if SubBuilding contains FLAT 1, SubBuildingNumber contains 1 if a sufficient level of parsing detail exists within a particular country.
SubBuildingName [in,out]	provides the descriptive name within the SubBuilding field. For example: If the address contains BASEMENT, SubBuilding and SubBuildingName contain BASEMENT. If the address contains Ste 11, SubBuildingName is blank. SubBuilding will contain Ste 11 and SubBuildingNumber will contain 11.
OrganizationName [in,out]	provides the trailing type indicator contained within the Organization field. For example, if Organization contains Loqate Inc, OrganizationName contains Loqate if a sufficient level of parsing detail exists for the particular country.
OrganizationType [in,out]	provides the trailing type indicator contained within the Organization field. For example, if Organization contains Loqate Inc, OrganizationType contains Inc if a sufficient level of parsing detail exists for the particular country.
PostBoxType [in,out]	provides the type indicator contained within the PostBox field. For example, 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]	provides the alphanumeric indicator contained within the PostBox field. For example, if PostBox contains PO BOX 1234, PostBoxNumber contains 1234 if a sufficient level of parsing detail exists for the particular country.

Address [in,out]

specifies the full mailing address in the relevant country.

Address1, Address2, ... Address12 [in,out]

specifies input data for the address line in the relevant country, split into individual address lines.

DeliveryAddress [out]

specifies the full address including line breaks without the Organization, Locality, AdministrativeArea and PostalCode fields.

DeliveryAddress1, DeliveryAddress2...DeliveryAddress12 [out]

specifies the individual lines contained within the DeliveryAddress field.

Country [in]

provides the country name or code.

CountryName [out]

provides the ISO 3166 official country name.

ISO3166-2 [out]

provides the ISO 3166 2-character country code.

ISO3166-3 [out]

provides the ISO 3166 3-character country code.

ISO3166-N [out]

provides the ISO 3166 3-digit numeric country code.

SuperAdministrativeArea [in,out]

provides the largest geographic data element within a country.

AdministrativeArea [in,out]

provides the most common geographic data element within a country. For example, USA State, and Canadian Province.

SubAdministrativeArea [in,out]

provides the smallest geographic data element within a country. For example, USA County.

Locality [in,out]

provides the most common population center data element within a country. For example, USA City, Canadian Municipality.

DependentLocality [in,out]

provides a smaller population center data element, dependent on the contents of the Locality field. For example, Turkish Neighborhood.

DoubleDependentLocality [in,out]

provides the smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For example, UK Village

Thoroughfare [in,out]

provides the most common street or block data element within a country. For example, USA Street.

DependentThoroughfare [in,out]

provides the dependent street or block data element within a country. For example, UK Dependent Street.

Building [in,out]

provides the descriptive name identifying an individual location, if such a name exists.

Premise [in,out]

provides the alphanumeric code identifying an individual location, if such a code exists.

SubBuilding [in,out]

provides the secondary identifiers for a particular delivery point. For example, "FLAT 1" or "SUITE 212".

PostalCode [in,out]

provides the complete postal code for a particular delivery point, if such detail can be determined.

PostalCodePrimary [out]

provides the primary postal code used for a particular country. For example, USA Zip, Canadian Postcode, Indian PINcode.

PostalCodeSecondary [out]

provides secondary postal code information, if used in a particular country and if such detail can be determined and reference data is available. For example, USA Zip Plus 4.

Organization [in,out]

provides the business name associated with a particular delivery point, if such a name exists.

PostBox [out]

provides the post box for a particular delivery point, if it exists.

Unmatched [out]

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

Latitude [out]

provides the WGS 84 latitude in decimal degrees format.

Longitude [out]

provides the WGS 84 longitude in decimal degrees format.

GeoAccuracy [out]

provides the GeoAccuracy code. For further information, see GeoAccuracy Code.

GeoDistance [out]

provides the radius of accuracy in meters, giving an indication of the likely maximum distance between the given geocode and the physical location.

AddressFormat [out]

provides the elements of the address. For example, if Address contains 805 Veterans Blvd Redwood City CA 94063-1734, AddressFormat contains Premise Thoroughfare Locality AdministrativeArea PostalCode.

DeliveryAddressFormat [out]

provides the elements of the delivery address. For example, if Address contains 805 Veterans Blvd Redwood City CA 94063-1734, DeliveryAddressFormat contains Premise Thoroughfare Locality AdministrativeArea PostalCode.

MatchRuleLabel [out]

provides the label of the match rule used to match the input with the reference data. For further information, see the match rule syntax.

Contact [in,out]

provides the contact name.

Function [in,out]

provides the function or job title.

Department [in,out]

provides the organizational department.

LocalityExtra [out]

provides information that could be as part of the Locality field. This information is not mandatory but is necessary to obtain a complete delivery address. For example in a French address: 12 rue de la Gare, 75019 PARIS CEDEX, France. CEDEX will be considered as Locality Extra.

DependentLocalityName [in,out]

provides the name indicator within the DependentLocality field. For example, 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]

provides the type indicator within the DependentLocality field. For example, if DependentLocality contains Dong Cheng Qu, DependentLocalityType contains Qu if a sufficient level of parsing detail exists for the particular country.

DoubleDependentLocalityName [in,out]

provides the name indicator within the DoubleDependentLocality field. For example, 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]

provides the type indicator within the DoubleDependentLocality field. For example, if DoubleDependentLocality contains Xin Zhuang Zhen, DoubleDependentLocalityType contains Zhen if a sufficient level of parsing detail exists for the particular country.

ThoroughfarePreDirection [in,out]

provides the prefix directional contained within the Thoroughfare field. For example, if Thoroughfare contains N MAIN ST, ThoroughfarePreDirection contains N if a sufficient level of parsing detail exists for the particular country.

ThoroughfareLeadingType [in,out]

provides the leading thoroughfare type indicator within the Thoroughfare field. For example, 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]

provides the name indicator within the Thoroughfare field. For example, if Thoroughfare contains N MAIN ST, ThoroughfareName contains MAIN if a sufficient level of parsing detail exists for the particular country.

ThoroughfareTrailingType [in,out]

provides the trailing thoroughfare type indicator within the Thoroughfare field. For example, if Thoroughfare contains N MAIN ST, ThoroughfareTrailingType contains ST if a sufficient level of parsing detail exists for the particular country.

ThoroughfarePostDirection [in,out]

provides the postfix directional contained within the Thoroughfare field. For example, if Thoroughfare contains MAIN ST N, ThoroughfarePostDirection contains N if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfarePreDirection [in,out]

provides the prefix directional contained within the DependentThoroughfare field. For example, if DependentThoroughfare contains N MAIN ST, DependentThoroughfarePreDirection contains N if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfareLeadingType [in,out]

provides the leading thoroughfare type indicator within the DependentThoroughfare field. For example, 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]

provides the name indicator within the DependentThoroughfare field. For example, if DependentThoroughfare contains N MAIN ST, DependentThoroughfareName contains MAIN if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfareTrailingType [in,out]

provides the trailing thoroughfare type indicator within the DependentThoroughfare field. For example, if DependentThoroughfare contains N MAIN ST, DependentThoroughfareTrailingType contains ST if a sufficient level of parsing detail exists for the particular country.

DependentThoroughfarePostDirection [in,out]

provides the prefix directional contained within the DependentThoroughfare field. For example, if DependentThoroughfare contains MAIN ST N, DependentThoroughfarePostDirection contains N if a sufficient level of parsing detail exists for the particular country.

BuildingLeadingType [in,out]

provides the leading building type indicator within the Building field. For example, if Building contains BLOC C, BuildingLeadingType contains BLOC if a sufficient level of parsing detail exists for the particular country.

BuildingName [in,out]

provides the name indicator within the Building field. For example, if Building contains WESTMINSTER HOUSE, BuildingName contains WESTMINSTER if a sufficient level of parsing detail exists for the particular country.

BuildingTrailingType [in,out]

provides the name indicator within the Building field. For example, if Building contains WESTMINSTER HOUSE, BuildingTrailingType contains HOUSE if a sufficient level of parsing detail exists for the particular country.

PremiseType [in,out]

provides the leading premise type indicator within the Premise field. For example, if Premise contains Plot 7/7A, PremiseType contains Plot if a sufficient level of parsing detail exists within a particular country.

PremiseNumber [in,out]

provides the leading premise type indicator within the Premise field. For example, if Premise contains Plot 7/7A, PremiseNumber contains 7/7A if a sufficient level of parsing detail exists within a particular country.

PremiseExtra [out]

provides information that could be as part of the Premise field. This information is not mandatory but is necessary to obtain a complete delivery address. For example in a French address: 12 bis rue de la Gare, 75019 PARIS, France. Bis will be considered as Locality Extra.

SubBuildingType [in,out]

provides the leading sub-building type indicator within the SubBuilding field. For example, if SubBuilding contains FLAT 1, SubBuildingType contains FLAT if a sufficient level of parsing detail exists within a particular country.

SubBuildingLeadingType [in,out]

provides the leading sub-building type indicator within the SubBuilding field. For example, if SubBuilding contains FLAT 1, SubBuildingLeadingType contains FLAT if a sufficient level of parsing detail exists within a particular country.

SubBuildingNumber [in,out]

provides the leading sub-building type indicator within the SubBuilding field. For example, if SubBuilding contains FLAT 1, SubBuildingNumber contains 1 if a sufficient level of parsing detail exists within a particular country.

SubBuildingName [in,out]

provides the descriptive name within the SubBuilding field. For example:

If the address contains BASEMENT, SubBuilding and SubBuildingName contain BASEMENT.
If the address contains Ste 11, SubBuildingName is blank.
SubBuilding will contain Ste 11 and SubBuildingNumber will contain 11.

OrganizationName [in,out]

provides the trailing type indicator contained within the Organization field. For example, if Organization contains Loqate Inc, OrganizationName contains Loqate if a sufficient level of parsing detail exists for the particular country.

OrganizationType [in,out]

provides the trailing type indicator contained within the Organization field. For example, if Organization contains Loqate Inc, OrganizationType contains Inc if a sufficient level of parsing detail exists for the particular country.

PostBoxType [in,out]

provides the type indicator contained within the PostBox field. For example, 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]

provides the alphanumeric indicator contained within the PostBox field. For example, if PostBox contains PO BOX 1234, PostBoxNumber contains 1234 if a sufficient level of parsing detail exists for the particular country.

Did this page help you?