Lookup

Edited

Lookup is a selectable option that can be returned by the API that will break down the elements of the returned address. Lookup can be turned on or off on the Data tab of your Integration.

The format of Lookup is as follows:

Name

Description

country

The country of the found address.

language

The language the address was returned in.

charset

The character set (e.g., Latin, Cyrillic) the address was returned in.

variation

Indicates whether the returned address is Postal (P), Geographic (G), or Vanity (V). Only Irish addresses can return as Geographic or Vanity.

addressElements

The individual elements of the returned address. Results vary depending on the location of the address. For full details, see the Address Elements section below.

Address Elements

Irish Address Elements

Address Element

Description

organisationName

The name of the organisation associated with the address.

primaryThoroughfareName

The main street or road name of the address.

townAddressTypeId

Identifier representing the address type at town level.

townName

The name of the town for the address.

organisationSubAddressName

A sub-division within an organisation (e.g., department or unit name).

countyName

The name of the county in which the address is located.

eircode

The Irish postal code for the address.

townId

Unique identifier for the town.

buildingGroupRequired

Boolean indicating whether a building group value is required.

secondaryLocalityRequired

Boolean indicating whether a secondary locality field is required.

addressPointAddressTypeId

Identifier for the address type at address point level.

addressPointFullAddressLine

Boolean indicating whether the full address line is required at address point level.

addressPointId

Unique identifier for the address point.

addressPointSubBuildingNameRequired

Boolean indicating whether a sub-building name is required at address point level.

buildingAddressTypeId

Identifier for the address type at building level.

buildingId

Unique identifier for the building.

buildingNameRequired

Boolean indicating whether the building name is required.

countyId

Unique identifier for the county.

buildingNumber

The numeric identifier of the building.

countyRequired

Boolean indicating whether the county field is mandatory.

departmentNameRequired

Boolean indicating whether a department name must be provided.

nua

Boolean flag indicating whether the address is a NUA (Non-Unique Address).

organisationAddressTypeId

Identifier for the address type at organisation level.

organisationFullAddressLine

Boolean indicating whether a full organisation address line is required.

organisationId

Unique identifier for the organisation.

organisationNameRequired

Boolean indicating whether the organisation name is required.

organisationSubAddressNameRequired

Boolean indicating whether the organisation sub-address name is required.

primaryLocalityAddressTypeId

Identifier for the primary locality address type.

UK Address Elements

Address Element

Description

poBoxNumber

The P.O Box number associated with the address.

organisationName

The name of the organisation associated with the address.

departmentName

The specific department within an organisation.

subBuildingName

The name or identifier of a subdivision within a building (e.g., apartment, suite, unit).

buildingName

The official name of the building.

buildingNumber

The numeric identifier of the building.

thoroughfareName

The name of the main street or road.

thoroughfareDescriptor

The type of thoroughfare.

dependentThoroughfareName

The name of a secondary street that depends on or branches from a main thoroughfare.

dependentThoroughfareDescriptor

The type of dependent thoroughfare.

dependentLocality

A smaller area or neighbourhood within a post town.

doubleDependentLocality

An even smaller subdivision within a dependent locality.

postTown

The main postal town associated with the address.

concatenationIndicator

A flag indicating whether address elements should be concatenated when forming address lines.

deliveryPointSuffix

A suffix used to uniquely identify a specific delivery point within the same building or property.

smallUserOrganisationIndicator

A flag indicating whether the address belongs to a small user organisation (typically receiving limited mail volume).

US Address Elements

Address Element

Description

zipCode

The standard 5-digit postal ZIP code for the address.

aaZipPlus4

The extended ZIP+4 code providing more precise delivery information.

combinedStreetName

A single field combining street name.

combinedAddressSecondary

A combined field for secondary address information (e.g., apartment, suite, unit).

buildingFirmName

The name of a business or firm associated with the building.

baseAlternateCode

An alternate base code used for internal or postal reference.

preferredLstLineCtyStKey

Internal key representing the preferred last line city/state combination.

preferredLstLineCityStateName

The full preferred city and state name used on the last address line.

preferredLstLineCityStateNameAbbr

The abbreviated preferred city and state name used on the last address line.

preferredLstLineCountyName

The preferred county name associated with the last address line.

aaUspsAddressId

Unique identifier assigned to the address within USPS.

aaPrimaryNumber

The primary street/building number component of the address.

RoW Address Elements

Address Element

Description

countryName

The full name of the country where the address is located.

stateProvinceName

The name of the state, province, or primary administrative region.

placeName

The populated place name.

postalCode

The postal or ZIP code used for mail delivery.

streetName

The name of the street or road.

houseNumber

The numeric identifier assigned to a property on a street.

door

The specific door or entrance identifier within a building.

floor

The floor level within a multi-storey building.

buildingName

The official name of the building.

block

A block identifier within a development or neighbourhood.

landmarkNearby

A nearby landmark used to help describe the address location.

landmarkDirection

Directional information relative to a nearby landmark.

doubleDependentStreetName

The name of a smaller street dependent on a dependent street.

dependentStreetName

The name of a secondary street linked to a primary street.

streetNumber

A numeric identifier associated with the street.

postOfficeBox

The PO Box number for mail delivery.

majorMetropolitanArea

The major metro area associated with the address.

kilometerPost

A kilometre marker used to identify a location along a road.

plotCadaster

A cadastral or land registry plot reference number.

postOffice

The name of the serving post office.

buildingUnit

The unit number within a building (e.g., apartment, suite).

dependentLocality

A smaller locality within a town or city.

doubleDependentLocality

A subdivision within a dependent locality.

milePost

A mile marker reference used to identify a location.

distance

Distance-based location information.

harbourNumber

A numeric identifier within a harbour area.

harbourName

The name of a harbour associated with the address.

buildingComplex

The name of a larger complex containing multiple buildings.

townland

A small rural land division.

otherDependentArea

An additional dependent area not covered by standard locality fields.

countryCode

The ISO or standard country code.

stateProvinceCode

The abbreviated code for the state or province.

lastHouseNumber

The final house number in a range of addresses.

geographicCode

A geographic or administrative reference code.

separator

A formatting character or string used to separate address components.

countrySubdivision

A subdivision of a country.

landCode

A code identifying a land parcel or classification.

buildingCode

A code used to uniquely identify a building.

houseNumberString

The house number represented as a string.

alternativeStreetName

An alternate or historical name for the street.

addressSchemeReference

An integer reference identifying the address scheme used.