Loqate

Developer API  |  Everything Location  |  Address Record Fields

Everything Location - Address Record Fields

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.

Atomic Fields

Atomic fields are always populated and verified when appropriate.

Address

This field holds the full address, correctly formatted for mailing in the relevant country.

Address1, Address2, …, Address8

These fields will contain the correctly formatted address for mailing in the relevant country, split into individual address lines.

DeliveryAddress

This field holds the full address minus the Organization, Locality hierarchy, AdministrativeArea hierarchy and PostalCode hierarchy fields, correctly formatted for mailing in the relevant country.

Tip: as a general rule of thumb, addresses have two parts - fields that specify region, and fields that provide delivery information. The DeliveryAddress and DeliveryAddress(n) fields only provide the delivery information, which usually includes the Thoroughfare and everything above (such as Premise, Sub-builing, PO Box, etc). This is useful if your application stores data usinga combination of compound and component form, e.g. Line 1, Line 2, Line[...] City, State, Postcode.

DeliveryAddress1, DeliveryAddress2, …, DeliveryAddress8

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

CountryName

This field holds the ISO 3166 official country name.

ISO3166-2

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

ISO3166-3

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

ISO3166-N

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

SuperAdministrativeArea

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

AdministrativeArea

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

SubAdministrativeArea

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

Locality

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

DependentLocality

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

DoubleDependentLocality

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

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

DependentThoroughfare

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

Building

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

Premise

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

SubBuilding

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

PostalCode

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

PostalCodePrimary

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

PostalCodeSecondary

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

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

PostBox

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

Unmatched

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

Sub Fields

Often there are extra more detailed fields in the output address object. These fields are referred to as Sub Fields, and 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. Use them at your own risk, since the content is generally coming from the parsed input rather than the verified output.

Take a trial - no obligation, full support Get started