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 Return 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

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 must be included in the address at address point level.

buildingAddressTypeId

Identifier for the address type at building level.

buildingGroupRequired

Boolean indicating whether a building group must be included in the address.

buildingId

Unique identifier for the building.

 buildingNameRequired

Boolean indicating whether the building name must be included in the address.

 buildingNumber

The building number, which may be a single number or a range (e.g. "89-94").

countyId

Unique identifier for the county.

countyName

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

countyRequired

Boolean indicating whether the county must be included in the address.

departmentNameRequired

Boolean indicating whether a department name must be included in the address.

eircode

The Eircode (Irish postcode) for the address, without spaces.

nua

Boolean 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.

organisationName

The name of the organisation associated with the address.

organisationNameRequired

Boolean indicating whether the organisation name must be included in the address.

organisationSubAddressName

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

organisationSubAddressNameRequired

Boolean indicating whether the organisation sub-address name must be included in the address.

primaryLocalityAddressTypeId

Identifier for the address type at primary locality level.

primaryLocalityRequired

Boolean indicating whether the primary locality must be included in the address.

primaryThoroughfareId

Unique identifier for the primary thoroughfare (street or road).

primaryThoroughfareName

The main street or road name of the address.

primaryThoroughfareRequired

Boolean indicating whether the primary thoroughfare must be included in the address.

secondaryLocalityRequired

Boolean indicating whether a secondary locality must be included in the address.

secondaryThoroughfareRequired

Boolean indicating whether a secondary thoroughfare must be included in the address.

townAddressTypeId

Identifier for the address type at town level.

townId

Unique identifier for the town.

townName

The name of the town for the address.

townRequired

Boolean indicating whether the town must be included in the address.

UK Address Elements

Address Element

Description

buildingNumber

The numeric identifier of the building.

deliveryPointSuffix

A two-character code that, together with the postcode, uniquely identifies a delivery point (e.g. "2D").

postcode

The full postcode for the address (e.g. "SE6 1UB").

postcodeArea

The postcode area, the letters at the start of the postcode (e.g. "SE").

postcodeType

The postcode type: "S" for a small user or "L" for a large user (an organisation that receives a high volume of mail and has its own postcode).

postTown

The main postal town associated with the address.

thoroughfareDescriptor

The type of thoroughfare.

thoroughfareName

The name of the main street or road.

buildingName

The official name of the building.

concatenationIndicator

A flag indicating whether the building number and sub-building name should be joined without a space (e.g. "12A" rather than "12 A").

departmentName

The specific department within an organisation.

dependentLocality

A smaller area or neighbourhood within a post town.

dependentThoroughfareDescriptor

The type of dependent thoroughfare.

dependentThoroughfareName

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

doubleDependentLocality

An even smaller subdivision within a dependent locality.

organisationName

The name of the organisation associated with the address.

poBoxNumber

The PO Box number associated with the address.

smallUserOrganisationIndicator

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

subBuildingName

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

US Address Elements

Address Element

Description

aaMatchLevel

The level at which the address was matched.

aaPrimaryNumber

The primary street/building number component of the address.

aaSecondaryNumber

The secondary number of the address (e.g., apartment, suite, floor number).

aaTtAddressId

Unique identifier for the address from TomTom data.

aaUspsAddressId

Unique identifier assigned to the address within USPS.

aaZipPlus4

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

actionCode

The USPS action code for the record (e.g., A for add).

addressPrimaryHighNum

The highest primary number in the address range for the record.

addressPrimaryLowNum

The lowest primary number in the address range for the record.

addressPrimaryOddEven

Indicates whether the primary number range is odd (O), even (E) or both (B).

addressSecondaryAbbr

The abbreviation for the secondary address type (e.g., Apt, Ste, Fl).

addressSecondaryHighNum

The highest secondary number in the address range for the record.

addressSecondaryLowNum

The lowest secondary number in the address range for the record.

addressSecondaryOddEven

Indicates whether the secondary number range is odd (O), even (E) or both (B).

baseAlternateCode

An alternate base code used for internal or postal reference.

buildingFirmName

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

carrierRouteId

The USPS carrier route that delivers to the address.

combinedAddressSecondary

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

combinedStreetName

A single field combining street name.

congressionalDistNum

The congressional district number for the address.

countyNumber

The FIPS code for the county in which the address is located.

financeNumber

The USPS finance number for the post office serving the address.

plus4HighNumberSector

The first two digits of the highest ZIP+4 add-on in the range.

plus4HighNumberSegment

The last two digits of the highest ZIP+4 add-on in the range.

plus4LowNumberSector

The first two digits of the lowest ZIP+4 add-on in the range.

plus4LowNumberSegment

The last two digits of the lowest ZIP+4 add-on in the range.

preferredLstLineCarrierRouteRate

The carrier route rate sortation code for the preferred last line.

preferredLstLineCityDeliverIndicator

Indicates whether the preferred last line city has city delivery (Y/N).

preferredLstLineCityStateMailNameIndic

Indicates whether the preferred city name can be used for mailing (Y/N).

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.

preferredLstLineCityStateNameFacCode

The facility type for the preferred city/state name (e.g., P for post office).

preferredLstLineCountyName

The preferred county name associated with the last address line.

preferredLstLineCtyStKey

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

recordTypeCode

The USPS record type (e.g., S for street, H for high-rise, F for firm, P for PO Box).

streetName

The name of the street.

streetPreDirectional

The directional that comes before the street name (e.g., N, S, E, W).

streetSuffixAbbr

The abbreviated street suffix (e.g., St, Ave, Rd).

zipCode

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

RoW Address Elements

Address Element

Description

addressSchemeReference

An integer reference identifying the address scheme used.

countryName

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

houseNumber

The numeric identifier assigned to a property on a street.

otherDependentArea

An additional dependent area not covered by standard locality fields.

placeName

The populated place name.

postalCode

The postal or ZIP code used for mail delivery.

streetName

The name of the street or road.

alternativeStreetName

An alternate or historical name for the street.

block

A block identifier within a development or neighbourhood.

buildingCode

A code used to uniquely identify a building.

buildingComplex

The name of a larger complex containing multiple buildings.

buildingName

The official name of the building.

buildingUnit

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

countryCode

The ISO or standard country code.

countrySubdivision

A subdivision of a country.

dependentLocality

A smaller locality within a town or city.

dependentStreetName

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

distance

Distance-based location information.

door

The specific door or entrance identifier within a building.

doubleDependentLocality

A subdivision within a dependent locality.

doubleDependentStreetName

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

floor

The floor level within a multi-storey building.

geographicCode

A geographic or administrative reference code.

harbourName

The name of a harbour associated with the address.

harbourNumber

A numeric identifier within a harbour area.

houseNumberString

The house number represented as a string.

kilometerPost

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

landCode

A code identifying a land parcel or classification.

landmarkDirection

Directional information relative to a nearby landmark.

landmarkNearby

A nearby landmark used to help describe the address location.

lastHouseNumber

The final house number in a range of addresses.

majorMetropolitanArea

The major metro area associated with the address.

milePost

A mile marker reference used to identify a location.

plotCadaster

A cadastral or land registry plot reference number.

postOffice

The name of the serving post office.

postOfficeBox

The PO Box number for mail delivery.

separator

A formatting character or string used to separate address components.

stateProvinceCode

The abbreviated code for the state or province.

stateProvinceName

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

streetNumber

A numeric identifier associated with the street.

townland

A small rural land division.