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
  • Introduction
  • Benefits of using Address V2
  • Migration Timeline
  • Migration Checklist:
  • FAQ
  1. Loqate Harmony API
  2. Guides

Migrating to Address V2

Step by step guide to migrating to Address V2.

PreviousParcel Locker PlusNextSign up/ Login

Last updated 1 year ago

Introduction

This guide is written to assist upgrading to receive the benefits of using Address V2.

We have depreciated all api connections except Address V2. This is to enable us to better improve our services to you.

Address V2 separates concepts of:

Address Lookup (typeahead service ) and Address Validation (the validated data) into two defined endpoints.

  1. Address Lookup - the typeahead service

    1. API endpoint:

  2. Address Validation - the validated data package of the address

    1. API endpoint:

Benefits of using Address V2

We have implemented many improvements into Address V2 that can assist in problems encountered and knowledge gained from previous versions of our address lookup product(s).

  • No contractual changes. You've purchased address validation we continue to supply address validations through an improved service. We proto-rata transactions from V1 to V2 when putting migration in production.

  • The service is faster reducing loads and tuning compute by separating find and retrieve api endpoints.

  • Many issues with V1 have resolution features in V2 that is enables by changing your api requests. Within the migration we can address these to ensure you have the best solution for your changing business needs.

  • V2/address/find enables us to better monitor performance of find and bring new features to find functionality to improve our goal of finding target addresses the fastest with the least keystrokes.

  • V2/address/retrieve has the same response data package reducing effort to migrate.

  • V2 Reduces billable transaction ambiguity. Using V2 understand what is a Find and what is a Retrieve (Transaction) is independently monitored.

  • V1 is depreciated. We are reducing our effort in supporting this endpoint and investing that effort in improving V2. The less customers on V1 the faster we can bring improvements.

  • Improves our information security protocols to keep you and us safer.

Migration Timeline

We have depreciated all api connections prior to Address V2. We in the process of scheduling turn-off dates from 2024 until 2025 depending on the service.

Implementing V2 usually fully completed within 2 weeks.

The response package is the same as V1 meaning much of the complex work is re-usable from your V1 implementation.

Migration Checklist:

FAQ

Do I need to sign new contract?

No. Unless you have a very old contract or through migrating you need access to additional data.

What happens to my transaction limits?

Any transaction limit are pro-rata. We consider V2 another service to conduct address validations.

For example: You have purchased 240,000 transactions, you utilise 90,000 transactions with V1 you will have 150,000 left for V2.

Does it cost more?

No, usually once implemented it reduces your costs.

Has the Data changed?

Its the same and the response data is the same schema its migrating from Address V1 being https://hosted.mastersoftgroup.com/harmony/rest/{locale}/address.

Having the same schema greatly reduces the effort of migration as your existing processes should remain unchanged.

What are the best fields to use in integrations?

You want to use Universal Response objects when integrating. This is likely new since your last integation.

2) Read & share with developers within this documentation Loqate Harmony API > API Specification > Address > Address Validation and Lookup. In particular, the difference between Find and Retrieve api endpoints.

3) Read & share with developers to assist in implementing V2. If you need a library please ask as we have more than we publicly publish.

See Best Practice guide on

.../v2/address/find
.../v2/address/retrieve
Address V2 API documentation
client and/or server side libraries
Address Field Mappings.