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
  • Cleanse methods (AU/NZ)
  • address
  1. Loqate Harmony API
  2. API Specification
  3. Deprecated API services

Address Cleanse v1

Cleanse methods validate the single line input address based on the required source of truth.

Cleanse methods (AU/NZ)

Cleanse methods validate the single line input address based on the required source of truth.

Cleanse the supplied single-line address into its component parts based on the supplied SOT.

address

The cleanse method takes a concatenated address String in the fullAddress field of an AddressAu or AddressNz parameter. It then attempts to validate it based on the supplied sourceOfTruth into component parts which are then returned in a populated AddressAu or AddressNz object with additional attributes. We support AUPAF, GNAF and NZPAF in this version, and we are continuing the development to support more validations.

POST method it can allow to send a list of Addresses (maximum 100 per request) and then return a list of validated addresses.

Details of the processes for each available sourceOfTruth:

  • sourceOfTruth : GNAF (GNAFAddressStandardization + GNAFValidation)

  • sourceOfTruth : AUPAF (AMASAddressStandardization + AMASHAVE)

  • sourceOfTruth : NZPAF (NZAddressStandardiztion + NZPostcodeAllocation + NZHAVEGeoPAF)

Resource URL

	
    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/cleanse/address?sourceOfTruth=GNAF&fullAddress=220 GEORGE ST, SYDNEY
	    
	
    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/cleanse/address

Request

	
    {
        "payload": [ 
            { "fullAddress": "SE 202, 220 George Street, Syndey 2000" }, 
            { "fullAddress": "3 Orara Street, waitara nsw" }, 
            .... 
        ],
        "sourceOfTruth": "AUPAF"
    }
	    

Response

	
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [	            
            {	
                "fullAddress": "220 GEORGE STREET,SYDNEY NSW 2000",
                "country": "",
                "postcode": "2000",
                "street2": "",
                "street": "George Street",
                "streetNumber": "220",
                "postal": "",
                "postalNumber": "",
                "postalType": "",
                "buildingName": "",
                "subdwelling": "SE 202",
                "eid": null,
                "lotNumber": null,
                "flatUnitNumber": "202",
                "flatUnitType": "SE",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "streetSuffix": "",
                "streetType": "Street",
                "streetName": "George",
                "careOf": "",
                "exception": null,
                "locality": "SYDNEY",
                "state": "NSW",
                "attributes": {
                    "GNAFPIDPosition": "ROOFTOP",
                    "GNAFConfidence": "0",
                    "ParcelID": "1//DP75111",	       	                	
                    "MeshblockId": "10743811000",
                    "Latitude": "-33.86307089",	       	                	
                    "Longitude": "151.20781474",
                    "GNAFReliability": "2",
                    "GNAFPID": "GANSW710276621",
                    "GNAFPointPID": "GANSW710276621",
                    "GNAFGroupPID": "NSW2845405",
                    "GNAFLocalityPID": "NSW3749",	       	                	
                    "GeocodeLevel": "7"
                }
            },
            {   
                "fullAddress": "3-11 ORARA STREET,WAITARA NSW 2077",
                "country": "",
                "postcode": "2077",
                "street2": "",
                "street": "Orara Street",
                "streetNumber": "3-11",
                "postal": "",
                "postalNumber": "",
                "postalType": "",					
                "buildingName": "",
                "subdwelling": "",
                "eid": null,
                "lotNumber": null,
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "streetSuffix": "",
                "streetType": "Street",
                "streetName": "Orara",
                "careOf": "",
                "exception": null,
                "locality": "waitara",
                "state": "nsw",
                "attributes": {
                    "GNAFPIDPosition": "ROOFTOP",
                    "GNAFConfidence": "1",
                    "ParcelID": "110//SP75046",
                    "GNAFPointPID": "GANSW716818114",
                    "MeshblockId": "11205293800",
                    "Latitude": "-33.70872612",
                    "GNAFPID": "GANSW716818114",
                    "Longitude": "151.10400679",
                    "GNAFReliability": "2",
                    "GNAFLocalityPID": "NSW4122",
                    "GNAFGroupPID": "NSW2895995",
                    "GeocodeLevel": "7"
                }
            },
            .......
        ]
    }
	    
PreviousAddress v1NextAddress International

Last updated 1 year ago

The request body is an object:

See for integration best practices.

The response body is an object:

Address Field Mapping Gui
de
address
AddressRestRequest
AddressRestResponse