Address Component Model

Address

The address object types used to represent addresses; can be either entities or data containers

Country ISO Code

The ISO 3166 2-character country code

Input Address 1

Input address line field, for one part of an address, e.g., street number and name

Input Address 2

Input address line field, for one part of an address, e.g., city, state abbreviation, postcode

Input Address 3

Input address line field, for one part of an address, e.g., country

Input Address 4

Input address line field, for one part of the full address

Typically used if optional information is put into one of the other input Address1 - 3 fields

Input Address Line

Single line input field for an entire address

Input Building

Input field for name identifying an individual location, e.g., a building

Input City

Input field for name of a large population center, e.g., city or municipality

Input Country

Input field for country name or code

Input County

Input field for small geographic unit within a country, e.g., county.

Input Dependent Locality

Input field for a small geographic unit within a city, e.g., neighborhood

Input Dependent Street

Input field for street information that depends on an adjoining road

Input Organization

Input field for business name associated with location

Input PostBox

Input field for post box for a location

Input State

Input field for name of a geographic unit within a country, e.g., state or province

Input Street

Input field for street information, e.g., street name and number

Input Street Name

Input field for street name

Input Street Number

Input field for street number identifying an individual location

Input Subbuilding

Input field for secondary identifier of an individual location, e.g., flat or suite

Input Zip

Input field for complete postal code

Latitude

The address latitude

Longitude

The address longitude

Geocode Latitude

Output field containing the address latitude

Geocode Longitude

Output field containing the address longitude

Standardized Building

Output field for name identifying an individual location, e.g., a building

Standardized City

Output field for a large population center name, e.g., city or municipality

Standardized City Extra

Output field for supplemental information related to city

Standardized Country

Output field containing country name or code

Standardized Country ISO Code

Output field containing the ISO 3166 2-character country code

Standardized Country ISO 3 Character Code

Output field containing the ISO 3166 3-character country code

Standardized County

Output field for small geographic unit within a country, e.g., county

Standardized Department

Output field for department name associated with an organization

Standardized Dependent Street

Output field for street information that depends on adjoining road

Standardized Double Dependent Locality

Output field for small population center within a city, e.g., village.

Standardized Formatted Address

Output field for the address formatted for mailing usage, formatted using CRLF (“\n”) as the line break

Standardized Neighbourhood

Output field for population center within a city, e.g., neighborhood

Standardized Organization

Output field for business name associated with location

Standardized PostBox

Output field for post box for a location

Standardized Region

Output field for the largest geographic unit within a country

Standardized State

Output field for a geographic unit within a country, e.g., state or province

Standardized Street

Output field for street name

Standardized Street Name

Output field for street name

Standardized Street Number

Output field for street number

Standardized Street Type

Output field for street type, e.g., Rd for road and St for street

Standardized SubBuilding

Output field for secondary identifier for an individual location, e.g., flat or suite

Standardized Zip

Output field for complete postal code

Geocode Accuracy

Output field for Geocode Accuracy. This field indicates the precision level of the geocode that has been assigned to an address by Loqate.

Geocode Distance

Output field for the Geocode Distance. This field indicates the uncertainty in the physical location of the address.

Quality

Quality attribute for address. Validation base type is text; attribute is a calculated attribute based on other quality fields. For example, the calculation could be a combination of the values of Quality Index and Quality Verification Code. Users are responsible for writing this formula.

Quality Index

Output field for the address quality index, which is used to indicate the quality of an address.

Quality Verification Code

Output field for the Address Verification Code. This is used to indicate the level of verification of an address.

Validation Hash

Hash value (numerical representation) for the address validation integration.

Contains a hash value of all input fields. Since comparing two numbers is simpler than comparing all involved values of the address, the hash value is used to determine if the address has changed since the last validation.

If the hash values of two addresses are equal, then the actual addresses are most likely also equal. For two identical addresses, the hash values are always be the same. If two addresses are different, the hash values for the two objects are likely to be distinct, but there is no guarantee.

For example, on a system with more than 100,000 addresses, it is expected that several addresses that are very different have the same hash value. However, for any specific address, the likeliness that the next version of that address has the same hash value is 1 per 4 billion. This means that in a system with 100 million addresses, if a user updates every address, there is less than a 5 percent chance that even a single one of those address changes is not sent to Loqate because the hash value is unchanged.

This field is calculated by STEP and updated whenever the standardized address attributes are updated by the Loqate integration.

Validation Integration Status

Contains the latest status of the address validation integration.

Field is updated whenever the standardized address attributes are updated by the Loqate integration. Indicates if the last address validation was completed or resulted in an error. Valid values are: <empty> and Failed.

This field makes it possible to search for accounts and addresses where an error has occurred during the address validation.

Validation Response

Output field for the cached validation response. This field contains the full response from Loqate.

Validation base type is text; maximum length must be at least 1000.