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
  • License Criterion
  • Activating Global Phone Validation
  • Phone and Email Access Configuration File
  • 1. Base URL of Harmony Hosted
  • 2. Default country for Phone Validation
  • 3. API user and password to access Hosted Phone API
  • 4.API user and password to access Hosted Email API
  1. Harmony Suite
  2. User Guides
  3. Version 3.0.0
  4. Email and Phone Validation

Prerequisites

A comprehensive guide that signifies the essential requirements that needs to be met to access Phone and Email Validation PDPs. Before you begin, please follow the steps outlined below.

License Criterion

To access the Email/ Phone Validation, you must meet the following prerequisites:

Harmony License Key: Obtain a valid Harmony license key from our support team.

If a customer wishes to utilize the Email and Phone Validation PDPs, they must possess a Harmony.key that grants access to both of these features, as they are separate licensable modules.

You will need an Account for Loqate AU NZ Haromy API's.

Register for an account here or contact our support.

https://www.loqate.com/anz/register/

Activating Global Phone Validation

To enable global phone validation, users must set the pass-through-unknown flag in the $HARMONY_HOME/config/scrubbing/scrubbing_phone.xml file to true.

<ph:pass-through-unknown>true</ph:pass-through-unknown>

By default, this flag is set to false, which means that international number validation cannot be processed.

Phone and Email Access Configuration File

The hosted.properties configuration file can be found in the $HARMONY_HOME/config/scrubbing directory. This file specifies the configurations used to manage the access of Phone/Email Validation PDPs to initiate Harmony Hosted API calls. It utilizes an API user to control access to specific Hosted accounts.

Note: Any changes to this file will require restart of application.

1. Base URL of Harmony Hosted

Default Property :

#hosted.basePath=https://hosted.mastersoftgroup.com/harmony

Remember you will need an Account for Loqate AU NZ Harmomy API's. Register for an account here or contact our support.

https://www.loqate.com/anz/register/

2. Default country for Phone Validation

Default property: hosted.defaultCountry=AU

User can configure this property to AU/NZ.

When the 'hosted.defaultCountry' property is configured to AU, it indicates that the user is validating phone number inputs using Australia as the default country. The following principles apply:

The same principle applies when the 'hosted.defaultCountry' is set to NZ.

In the input file containing numbers from various countries:

  • Australian (AU) numbers can undergo validation with or without a country code prefix.

  • For other international numbers, successful validation requires the prefix '+' and the country code.

3. API user and password to access Hosted Phone API

Default Property

hosted.apiUserForPhone=

hosted.apiPasswordForPhone=

User can configure this property with correct api user and password.

hosted.apiUserForPhone=XXXX

hosted.apiPasswordForPhone=XXXXXX

4.API user and password to access Hosted Email API

Default Property

hosted.apiUserForEmail=

hosted.apiPasswordForEmail=

User can configure this property with correct api user and password.

hosted.apiUserForEmail=XXXX

hosted.apiPasswordForEmail=XXXX

PreviousEmail and Phone ValidationNextPhone and Email PDP Configuration Setup

Last updated 10 months ago