LookupResult
The facts that a lookup returned for one postcode.
Properties
Section titled “Properties”administrativeAddress
Section titled “administrativeAddress”
readonlyadministrativeAddress:AdministrativeAddress|null
The names of the places that hold the postcode, from level 2, or null.
buildingUseStatus
Section titled “buildingUseStatus”
readonlybuildingUseStatus:string|null
What the building is used for, from level 3, or null.
levelReceived
Section titled “levelReceived”
readonlylevelReceived:LookupLevel
The lookup level of the data in the response, which the client reads from its fields.
levelRequested
Section titled “levelRequested”
readonlylevelRequested:LookupLevel
The lookup level that the caller asked for.
postcode
Section titled “postcode”
readonlypostcode:Postcode
The postcode that the caller asked for, as the core parsed it.
recentHouseAddress
Section titled “recentHouseAddress”
readonlyrecentHouseAddress:string|null
The most recent house address at the postcode, from level 2, or null.
status
Section titled “status”
readonlystatus:string|null
The gateway’s verdict as text, such as a LookupStatus, or null when it sent none.
readonlyvalid:boolean
True when the gateway knows the postcode.
Unofficial. Not made or endorsed by NIPOST.