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
  • Resource
  • Request
  • Response
  1. Loqate Harmony API
  2. Address Exchange (Beta)
  3. ADX API Specification

Create Address

Creates address in Address Exchange using structured data

PreviousADX API SpecificationNextGet Address

Last updated 10 months ago

Resource

POST    https://hosted.mastersoftgroup.com/harmony/rest/address/exchange/v1/addresses

Request

The request body is similar to object.

{
  // Part of Country 
  "country": "AU", //Required in ISO-2 format. 
  
  //  Part of Premise level data. Need at least one (usually streetNumber)
  "streetNumber": "string", //  Optional. Most commonly used in 99% addresses.
  "buildingName": "string", //  Optional.
  "flatUnitNumber": "string", //  Optional. Must use with flatUnitType
  "flatUnitType": "string", //  Optional. Must use with flatUnitNumber
  "floorLevelNumber": "string", //  Optional. Must use with floorLevelType
  "floorLevelType": "string", //  Optional. Must use with floorLevelNumber
  
  // Part of Street level data
  "streetName": "string", // Required. Must use with streetType
  "streetType": "string", // Required. Must use with streetName
  
  //Part of City level data
  "suburb": "string", // Required. Known as City. 
  "postcode": "string", // Optional. Known as Zip or Postcode. 
  
  //  Part of Province level data
  "state": "string", // Required.
  
  //  Geocodes in wgs84 EPSG: 4326
  "latitude": "string", // wgs84 EPSG: 4326
  "longitude": "string" // wgs84 EPSG: 4326
}

Creating an address requires completion of the all the data levels being:

  1. Premise level: One or many. Most common is streetNumber.

    1. buildingName,

    2. flatUnitNumber and flatUnitType,

    3. floorLevelNumber, floorLevelType,

    4. streetNumber

  2. Street level: Completion of both parts is required.

    1. streetName and streetType

  3. City level: Suburb must be completed. Postcode is optional

    1. suburb

    2. postcode

  4. Province level:

    1. state has the same meaning as province.

  5. Country level:

    1. country in ISO2 format is required.

Response

The response plays back the submitted Address with status.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": {
        "uuid": "788c4c23-fb69-4296-87aa-0650d514283f",
        "createDate": 1691992029508,
        "updateDate": 1691992029508,
        "assessments": [
            {
                "uuid": "13bf0035-f939-4f08-8a62-a9e9860e0872",
                "assessmentDate": 1691992029673,
                "events": null,
                "score": null
            }
        ],
        "attributes": null,
        "country": "AU",
        "postcode": "3144",
        "suburb": "MALVERN",
        "state": "VIC",
        "line1": null,
        "line2": null,
        "streetNumber1Prefix": null,
        "streetNumber1": "23",
        "streetNumber1Suffix": "",
        "streetNumber2Prefix": null,
        "streetNumber2": "25",
        "streetNumber2Suffix": "",
        "postalType": null,
        "postalNumber": null,
        "buildingName": "",
        "subdwelling": null,
        "lotNumber": "",
        "flatUnitNumber": "",
        "flatUnitType": "",
        "floorLevelNumber": "",
        "floorLevelType": "",
        "streetSuffix": "",
        "streetType": "PDE",
        "streetName": "MILTON",
        "rdNumber": "",
        "district": null,
        "latitude": "-37.84615841",
        "longitude": "145.03898928",
        "description": null,
        "fullAddress": "23-25 MILTON PDE, MALVERN VIC 3144"
    }
}

AddressRestRequest