Address Lookup Using CUSTOM SoT

This section shows how the HRA address lookup process utilises the CUSTOM SoT to return consolidated address records.

Sample Request and Response

Request: similar-addresses

{
  "option": {
    "source": "CUSTOM",
    "sourceNames": ["TUI"] 

},
  "payload": {
    "fullAddress": "10 Papatoetoe"
  }
}

Response: similar-addresses

{
  "status": "SUCCESS",
  "messages": [],
  "payload": [
    {
      "fullAddress": "1/10 PHOENIX PLACE, PAPATOETOE, AUCKLAND 2025",
      "addressLine1": "1/",
      "addressLine2": "10 PHOENIX PLACE",
      "addressLine3": "PAPATOETOE",
      "addressLine4": "AUCKLAND 2025",
      "localityName": "PAPATOETOE",
      "postcode": "2025",
      "streetName": "PHOENIX",
      "streetType": "PLACE",
      "houseNumber1": "10",
      "flatUnitNumber": "1",
      "townCityName": "AUCKLAND",
      "latitude": "-36.9743863",
      "longitude": "174.8401540",
      "id": "6616652",
      "attributes": {
        "TIL_TOWN_NAME": "MANUKAU",
        "city": "AUCKLAND",
        "district": "PAPATOETOE",
        "flat_number_1": "1",
        "full_address": "1 10 PHOENIX PLACE, PAPATOETOE MANUKAU 2025",
        "record_type": "address",
        "source": "CUSTOM",
        "sourceName": "CUSTOM/TUI"
      }
    }
  ]
}