Loqate Harmony Documentation
  • GBG Loqate AU & NZ
  • Loqate Harmony API
    • Sign up for free trial
    • Login
    • API Specification
      • Authentication
      • Address
        • Address Validation & Lookup
        • Address by Geocode
        • Address Cleanse
        • Address Parse
        • Geocode Intl
      • Address Insights
        • Australian Insights
          • SEIFA Australia
          • ASGS Australia Statistical Geography Standard
          • Residential / Commercial
          • Deliverable address
      • Suburb Lookup
      • Business Validation and Lookup
      • Email Validation
      • Phone Validation
      • Matching
      • Moved Suppression
      • Deceased Suppression
      • Objects
        • Address Objects
        • Address Type Objects
        • Suburb Objects
        • Parse Objects
        • Email Objects
        • Phone Objects
        • Property Title Objects
        • Match Objects
        • Business Objects
      • Deprecated API services
        • Email Validation v1.1
        • Address v1
        • Address Cleanse v1
        • Address International
        • Address Combined
        • Address Types
    • Guides
      • Best Practices
        • Address Field Mappings
        • Finding an Address
      • User Derived Address
      • Expanded sub-premise reach
      • Parcel Locker Plus
      • Migrating to Address V2
      • Sign up/ Login
      • Support
      • Console
        • Getting your API keys
        • Getting Started
        • Add a Service
        • Dashboard
        • Subscriptions
          • Features
          • Users
          • Subscribed Plans
          • Allowlisting domains
          • Blocklist - Email Validation
        • Reports
        • Invoices
          • Paying Invoices
      • API Latency
    • Demos
      • How to use our demos
      • Address Validation Demo
      • Address by Geocode (Reverse Geocode) Demo
      • Address Cleanse Demo
      • Address Parse Demo
      • Business Validation Demo
      • Email Validation Demo
      • Phone Validation demo
    • Integrations
      • Client Libraries
        • Javascript Library v2.1.0
      • Adobe Commerce (Magento 2) Plugin
        • Magento2 User Guide
      • Woocommerce Plugin
        • Woocommerce Install Guide v2.0.0
        • Woocommerce Settings guide v2.0.0
      • Shopify Plus App
      • Gravity Forms
      • Voxco Survey Software
      • Salesforce CRM
      • Dynamics 365 CRM
      • Batch App - Lightweight
      • Deprecated Integrations
        • Harmony RightAddress c# example
        • Harmony RightAddress cURL example
        • Deprecated JS Library v2.0.1
        • Deprecated JQuery Library v1.8.1
    • Coverage
    • Address Exchange (Beta)
      • ADX Console
        • Searching Addresses in console
        • Create Address in console
        • Create Actions in console
      • ADX API Specification
        • Create Address
        • Get Address
        • Create Address Event
        • Edit Address Event
        • Create/Edit Address Attributes
        • Create/Edit Address Geopoint
        • Get Source Events
      • Reserved Attributes
    • GBG Status
  • Batch / Bulk Data Services
    • Serviced Batch
      • Bulk Address Cleanse
      • Email Serviced Batch
      • Phone Serviced Batch
      • Business Serviced Batch
  • Harmony Suite
    • Harmony Suite Overview
    • Release Notes
      • Version 3.0.0
        • New Features
        • Enhancements
        • Bug Fixes
        • Supported Platforms
    • User Guides
      • Version 3.0.0
        • Welcome to Harmony Suite
        • Glossary of terms
        • Upgrades
          • HSQL Upgrade
        • Email and Phone Validation
          • Prerequisites
          • Phone and Email PDP Configuration Setup
          • Phone Validation using Harmony Batch System
          • Phone Validation using Harmony WS
          • Email Validation using Harmony Batch
          • Email Validation using Harmony WS
          • Guides
            • Understanding Phone Data
            • Understanding Email Data
        • Business Lookup and Validation
          • Prerequisites
          • Business Lookup
          • Business Validation
            • Business Validation using Commercial Name Parser
            • Business Validation Configurations
            • Business Validation using Harmony Batch System
            • Business Validation using Harmony WS
          • Business data update guide
          • Guides
            • Understanding Business Data
            • Understanding Business Verification Code
            • Name Parse Ambiguity
        • Australia Post Parcel Locker Plus Lookup and Validation
          • Prerequisites
          • Australia Post Parcel Locker Plus Lookup
          • Australia Post Parcel Locker Plus Validation
            • PDP Configuration Setup
            • AupostValidation using Harmony Batch System
            • AupostValidation using Harmony WS
          • Guides
            • Knowledgebase Lexical Update
            • Understanding Australia Post Parcel Locker Plus Data
            • Interchangeable terms for Australia Post Parcel Lockers
        • Installation and Upgrade Reference Guide
        • Locate Reference Guide
        • Extensions Reference Guide
        • RealTime Reference Guide
        • Postmaster Reference Guide
        • Rapid Address ANZ Reference Guide
        • Post ANZ Reference Guide
        • Source of Truth Installation Reference Guide
        • Knowledgebase Configuration Reference Guide
        • Web Services Reference Guide
        • Management Console Reference Guide
        • Batch System Match Reference Guide
        • Batch System Cleanse Reference Guide
  • More from GBG
    • GBG GreenID
    • GBG Identity
    • GBG Fraud & Compliance
Powered by GitBook
On this page
  • Address lookup methods (AU/NZ)
  • address
  • buildingName
  • locality
  • postal
  • postcode
  • street
  • streetNumber
  • subdwelling
  • subdwellingAddress
  • suburb
  • townCity
  • AUNZreverseGeocode
  • transaction
  1. Loqate Harmony API
  2. API Specification
  3. Deprecated API services

Address v1

PreviousEmail Validation v1.1NextAddress Cleanse v1

Last updated 1 year ago

These methods have been deprecated.

We recommend you upgrade your service to the latest . Upgrade at no cost and improved performance.

Address lookup methods (AU/NZ)

Address lookup methods take complete or partial address information as an input and perform a search against an address Source of Truth, returning address information that matches the search parameters.

Lookup addresses using a single-line input address.

Lookup building names.

Lookup Australian localities.

Lookup postal addresses (such as PO Boxes).

Lookup postcodes.

Lookup streets.

Lookup street numbers.

Lookup subdwellings.

List all subdwellings under a given address.

Lookup suburbs.

Lookup towns/cities in New Zealand.

Lookup addresses within a certain distance using geocode input - for Australia and New Zealand.

Indicate that an address lookup transaction has been completed.

address

Lookup addresses using a single-line input address. If want to further filter the result by the locality level information, you can also specify the locality, postcode or state value

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/address
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/address
    

Request (POST)

  • The fullAddress attribute is required

    {
        "payload": [ { "fullAddress": "202 220 GEORGE ST" } ],
        "sourceOfTruth": "AUPAF"
    }
    
    If want to return addresses in NSW.
    {
        "payload": [ { "fullAddress": "202 220 GEORGE ST", "state": "nsw" } ],
        "sourceOfTruth": "AUPAF"
    }
 

Request Parameters (GET)

  • The fullAddress attribute is required

  • The sourceOfTruth attribute is required

  • The locality attribute is optional

  • The postcode attribute is optional

  • The state attribute is optional

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "L 2 SE 202 220 GEORGE ST, SYDNEY NSW 2000",
                "country": null,
                "exception": null,
                "postcode": "2000",
                "street2": null,
                "street": "GEORGE ST",
                "streetName": "GEORGE",
                "streetSuffix": "",
                "streetType": "ST",
                "streetNumber": "220",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "L 2 SE 202",
                "flatUnitNumber": "202",
                "flatUnitType": "SE",
                "floorLevelNumber": "2",
                "floorLevelType": "L",
                "lotNumber": "",
                "eid": "DWhlfKqXLLSTYjra7PXq+VYtLDV4rJM6",
                "state": "NSW",
                "locality": "SYDNEY"
            }
        ]
    }
 

buildingName

Performs a search for building names using the supplied buildingName.

Additional information supplied in the request will further filter the results.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/buildingName
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/buildingName
    

Request (POST)

  • The buildingName attribute is required

  • The postcode attribute is optional

  • The locality attribute is optional

  • The townCity attribute is optional (New Zealand)

  • The suburb attribute is optional (New Zealand)

  • The street attribute is optional

  • The streetNumber attribute is optional

  • The featureOptions attribute is optional

    {
        "payload": [ { "buildingName": "anz" } ],
        "sourceOfTruth": "AUPAF"
    }
    

Request Parameters (GET)

  • The buildingName attribute is required

  • The sourceOfTruth attribute is required

  • The postcode attribute is optional

  • The locality attribute is optional

  • The transactionID attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "",
                "exception": null,
                "country": null,
                "postcode": "0870",
                "street2": null,
                "street": "SCHWARZ CRES",
                "streetName": "SCHWARZ",
                "streetSuffix": "", 
                "streetType": "CRES",
                "streetNumber": "26",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "ANZAC HILL HIGH SCHOOL",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "",
                "eid": "",
                "state": "NT",
                "locality": "ALICE SPRINGS"
            }, 
            ...
        ]
    }
    

locality

Performs an Australian locality search using the supplied information.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/locality
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/locality
    

Request (POST)

  • The locality attribute is required for non-semi locality search

  • The postcode attribute is optional

  • The fullAddress attribute is required for semi locality search

    {
        "payload": [ { "locality": "SYD" } ],
        "sourceOfTruth": "AUPAF"
    }
    
    For Semi structure locality search:    
    {
        "payload": [ { "fullAddress":"SYDNEY 2000"} ],
        "sourceOfTruth": "AUPAF"
    }

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The locality attribute is required for non-semi locality search

  • The postcode attribute is optional

  • The fullAddress attribute is required for semi locality search

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "SYDNEY NSW 2000",
                "attributes": {},
                "exception": null,
                "country": null,
                "postcode": "2000",
                "street2": null,
                "street": "",
                "streetName": "",
                "streetSuffix": "", 
                "streetType": "",
                "streetNumber": "",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "", 
                "eid": "",
                "state": "NSW",
                "locality": "SYDNEY"
            },
            ...
        ]
    }
    

postal

Performs a search for a postal address using the supplied information.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/postal
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/postal
    

Request (POST)

  • The postal is required

  • Either the postcode or locality attribute is required

    {
        "payload": [ { "postcode": "2000", "postal": "Locked Bag 1" } ],
        "sourceOfTruth": "AUPAF"
    }
    

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The postal is required

  • Either the postcode or locality attribute is required

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "LOCKED BAG 1, MILLERS POINT NSW 2000",
                "country": null,
                "exception": null,
                "postcode": "2000",
                "street2": null,
                "street": "",
                "streetName": "",
                "streetSuffix": "", 
                "streetType": "",
                "streetNumber": "",
                "postal": "LOCKED BAG 1",
                "postalNumber": "1",
                "postalType": "LOCKED BAG",
                "buildingName": "",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "",
                "eid": "6So/3cBB43g9gZ5h97tjVlAP6KSxW63k",
                "state": "NSW",
                "locality": "MILLERS POINT"
            },
            ...
        ]
    }
    

postcode

Performs a postcode search using the supplied information.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/postcode
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/postcode
    

Request (POST)

  • The postcode attribute is required

    {
        "payload": [ { "postcode": "3000" } ],
        "sourceOfTruth": "AUPAF"
    }
    

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The postcode attribute is required

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "BARANGAROO NSW 2000",
                "country": null,
                "exception": null,
                "postcode": "2000",
                "street2": null,
                "street": "",
                "streetName": "",
                "streetSuffix": "", 
                "streetType": "",
                "streetNumber": "",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "",
                "eid": "",
                "state": "NSW",
                "locality": "BARANGAROO"
            },
            ...
        ]
    }
    

street

Performs a street search using the supplied information.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/street
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/street
    

Request (POST)

  • The street attribute is required

  • The postcode attribute is optional

  • The locality attribute is optional

  • The townCity attribute is optional (New Zealand)

  • The suburb attribute is optional (New Zealand)

    {
        "payload": [ { "street": "GEORGE" } ],
        "sourceOfTruth": "AUPAF"
    }
    

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The street attribute is required

  • The postcode attribute is optional

  • The locality attribute is optional

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "GEORGE ST, HAYMARKET NSW 2000",
                "attributes": {},
                "country": null,
                "exception": null,	
                "postcode": "2000",
                "street2": null,
                "street": "GEORGE ST",
                "streetName": "GEORGE",
                "streetSuffix": "", 
                "streetType": "ST",
                "streetNumber": "",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "",
                "eid": "",
                "state": "NSW",
                "locality": "HAYMARKET"
            },
            ...
        ]
    }
    

streetNumber

Performs a street number search using the supplied information.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/streetNumber
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/streetNumber
    

Request (POST)

  • The streetNumber attribute is required

  • The postcode attribute is required

  • The locality attribute is required

  • The townCity attribute is optional (New Zealand)

  • The suburb attribute is optional (New Zealand)

  • The street attribute is required

    {
        "payload": [ 
            { 
                "postcode": "2000",
                "locality": "SYDNEY",
                "street": "GEORGE",
                "streetNumber": "220"
            } 
        ],
        "sourceOfTruth": "AUPAF"
    }
    

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The streetNumber attribute is required

  • The postcode attribute is required

  • The locality attribute is required

  • The street attribute is required

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "",
                "attributes": {
                	"Barcode": "1301011211020102222010332230110202013", 
                	"Bsp": "015", 
                	"DPID": "12345678"
                },
                "country": null,
                "exception": null,
                "postcode": "2000",
                "street2": null,
                "street": "GEORGE ST",
                "streetName": "GEORGE",
                "streetSuffix": "", 
                "streetType": "ST",
                "streetNumber": "220",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "",
                "eid": "6So/3cBB43g9gZ5h97tjVlAP6KSxW63k",
                "id": "12345678",
                "state": "NSW",
               	"locality": "SYDNEY"
            }
        ]
    }
    

subdwelling

Performs a subdwelling search using the supplied information.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/subdwelling
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/subdwelling
    

Request (POST)

  • The subdwelling attribute is required

  • The postcode attribute is optional

  • The locality attribute is optional

  • The townCity attribute is optional (New Zealand)

  • The suburb attribute is optional (New Zealand)

  • The street attribute is optional

  • The streetNumber attribute is optional

    {
        "payload": [ 
            {
                "postcode": "2000",
                "locality": "SYDNEY",
                "street": "GEORGE",
                "streetNumber": "220",
                "subdwelling": "202"
            } 
        ],
        "sourceOfTruth": "AUPAF"
    }
    

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The subdwelling attribute is required

  • The postcode attribute is required

  • The locality attribute is required

  • The street attribute is required

  • The streetNumber attribute is required

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload":[
            {
                "fullAddress": "L 2 SE 202 220 GEORGE ST, SYDNEY NSW 2000",
                "attributes": {
                	"Barcode": "1301011211020102222010332230110202013", 
                	"Bsp": "015", 
                	"DPID": "12345678"
                },
                "country": null,
                "exception": null,
                "postcode": "2000",
                "street2": null,
                "street": "GEORGE ST",
                "streetName": "GEORGE",
                "streetSuffix": "",
                "streetType": "ST",
                "streetNumber": "220",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "L 2 SE 202",
                "flatUnitNumber": "202",
                "flatUnitType": "SE",
                "floorLevelNumber": "2",
                "floorLevelType": "L",
                "lotNumber": "",
                "eid": "tx99SZgKkuFvHO55bcst3we72s6/5vK4",
                "id": "12345678",
                "state": "NSW",
                "locality": "SYDNEY"
            }
        ]
    }
    

subdwellingAddress

List all subdwellings under a given address.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/subdwellingAddress
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/subdwellingAddress
    

Request (POST)

  • The id attribute is required

    {
        "payload": [ 
            {
                "id":"59676232"
            } 
        ],
        "sourceOfTruth": "AUPAF"
    }

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The id attribute is required

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
          {
            "fullAddress": "L 1 20 BOND ST, SYDNEY NSW 2000",
            "country": null,
            "postcode": "2000",
            "street2": null,
            "street": "BOND ST",
            "streetNumber": "20",
            "postal": "",
            "postalType": "",
            "postalNumber": "",
            "buildingName": "",
            "subdwelling": "L 1",
            "eid": "09A409957EAD7B0EF1A8C52D39795736AF93F9D0AE5B2014",
            "lotNumber": "",
            "flatUnitNumber": "",
            "flatUnitType": "",
            "floorLevelNumber": "1",
            "floorLevelType": "L",
            "streetSuffix": "",
            "streetType": "ST",
            "streetName": "BOND",
            "attributes": null,
            "id": null,
            "state": "NSW",
            "locality": "SYDNEY"
          },
          {
            "fullAddress": "L 2 20 BOND ST, SYDNEY NSW 2000",
            "omitted": "The rest of the reponse is omitted for readable "
          }
        ]
    }

suburb

Performs a New Zealand Suburb search using the supplied information.

The suburb method is only valid when the 'NZPAF' or 'NZAD' sourceOfTruth parameter is supplied.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/suburb
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/suburb
    

Request (POST)

  • The suburb attribute is required

  • The postcode attribute is optional

  • The townCity attribute is optional

    {
        "payload": [ { "suburb": "WELL" } ],
        "sourceOfTruth": "NZPAF"
    }

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The suburb attribute is required

  • The postcode attribute is optional

  • The townCity attribute is optional

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
            	"attributes": null,
                "fullAddress": "WELLINGTON CENTRAL, WELLINGTON 6011",
                "country": null,
                "exception": null,
                "id": null,
                "rdNumber": null,
                "postcode": "6011",
                "street": "",
                "streetName": "",
                "streetSuffix": "",
                "streetType": "",
                "streetNumber": "",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "",
                "eid": "",
                "townCity": "WELLINGTON",
                "suburb": "WELLINGTON CENTRAL"
            }
        ]
    }
    

townCity

Performs a lookup for Towns and Cities in New Zealand using the supplied information.

The townCity method is only valid when the 'NZPAF' or 'NZAD' sourceOfTruth parameter is supplied.

Resource URL

   POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/townCity
   

Or if using GET

   GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/townCity
   

Request (POST)

  • The townCity attribute is required

  • The postcode attribute is optional

    {
        "payload": [ { "townCity": "WELL" } ],
        "sourceOfTruth": "NZPAF"
    }
    

Request Parameters (GET)

  • The sourceOfTruth attribute is required

  • The townCity attribute is required

  • The postcode attribute is optional

  • The transactionID attribute is optional

  • The featureOptions attribute is optional

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "attributes": null,
                "fullAddress": "WELLSFORD 0900",
                "country": null,
                "exception": null,
                "id": null,
                "rdNumber": null,
                "postcode": "0900",
                "street2": null,
                "street": "",
                "streetName": "",
                "streetSuffix": "", 
                "streetType": "",
                "streetNumber": "",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "lotNumber": "",
                "eid": "",
                "suburb": "",
                "townCity": "WELLSFORD"
            },
            ...
        ]
    }
    

AUNZreverseGeocode

Lookup addresses through the specified Source of Truth within a certain distance using the geocode input.

For multiple geocode inputs, only the first record will be processed. The supported Source of Truths are 'GNAF', 'NZPAF', 'NZAD' and 'CNAR' (default is GNAF for Australia and NZPAF for New Zealand).

Resource URL

   GET/POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/reverseGeocode

Request

  • The attributes with latitude and longitude is required

  • The sourceOfTruth is optional. The supported Source of Truths are GNAF, NZPAF, NZAD, CNAR (default is GNAF for Australia and NZPAF for New Zealand).

  • The featureOptions is optional. The supported feature options are displayGnafLot, singleLineHitNumber (default 20), caseType, exposeAttributes, radius (default 50 for 50 meters radius).

    {
        "payload": [{"attributes": {"latitude":"-33.xxxxx", "longitude":"150.xxxxx"}}], 
        "sourceOfTruth": "GNAF",
        "featureOptions": {"radius":"100"}
    }

Response

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "LOT 1 13 MEROO STREET, BLACKTOWN NSW 2148",
                "country": null,
                "postcode": "2148",
                "street2": null,
                "street": "MEROO STREET",
                "streetNumber": "13",
                "postal": "",
                "postalType": "",
                "postalNumber": "",
                "buildingName": "",
                "subdwelling": "LOT 1",
                "eid": "209593C380BE0D2AD545B41361CFB7B00DE4251D77BA4C78C8A0918B2624A10E",
                "lotNumber": "1",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "streetSuffix": "",
                "streetType": "STREET",
                "streetName": "MEROO",
                "attributes": null,
                "id": null,
                "state": "NSW",
                "locality": "BLACKTOWN"
            },
            ...
        ]
    }

transaction

Indicates that an address lookup transaction has been completed.

The transaction method must be called when address has been found using the lookup process. It is used for audit and billing purposes.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/transaction
    

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/transaction
    

Request (POST)

    { 
        "sourceOfTruth": "AUPAF" 
    }
    

Request Parameters (GET)

  • The sourceOfTruth attribute is required

Response

    {
        "status": "SUCCESS", 
        "messages": [], 
        "payload": null 
    }
    

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

The request body is an object:

The response body is an object:

Address Validation method
address
buildingName
locality (AU only)
postal
postcode
street
streetNumber
subdwelling
subdwellingAddress
suburb (NZ only)
townCity (NZ only)
auNzReverseGeocode
transaction
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse
AddressRestRequest
AddressRestResponse