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
  • Email Validation
  • Phone Validation
  • Prerequisites:
  • Configurations for Phone and Email Validation:
  • Using Phone Validation
  • 1. Alignment of Default Locale and 'hosted.defaultCountry' for Phone Validation Users
  • 2. Guidance on Reviewing guides
  1. Harmony Suite
  2. User Guides
  3. Version 3.0.0

Email and Phone Validation

Enhance the quality of your Email and Phone data through comprehensive validation, minimizing errors and ensuring reliable information.

PreviousHSQL UpgradeNextPrerequisites

Last updated 1 year ago

Introduction

To perform email and phone validation we will use Pluggable Data Processing(PDP) modules effectively leveraging the Loqate Harmony APIs.

PDP for EMAIL: HostedEmailValidation

PDP for PHONE: HostedPhoneValidation

Email Validation

To complete email validation, HostedEmailValidation PDP can be chained within email data model to achieve a specific data cleansing exercise.

Performs a full mailbox validation on the supplied email address.

Email Validation works GLOBALLY, however, Harmony Suite requires Default Locale to be selected.

This service calls .

Phone Validation

To complete phone validation, HostedPhoneValidation PDP can be chained within phone data model to achieve a specific data cleansing exercise.

Performs Phone Validation for Australian, New_Zealand and international numbers.

Phone Validation works GLOBALLY, however, Harmony Suite requires Default Locale to be selected.

Note: Loqate Phone Validation requires precise international number format (ITU E.123), which includes prefix plus '+' followed by country code eg '+##'.

This service calls

Prerequisites:

A comprehensive guide that signifies the essential requirements that needs to be met to access Email or Phone Validation.

Configurations for Phone and Email Validation:

This section provides insights into configuring the Phone Validation and Email Validation PDP setup using Harmony Management Console.

Using Phone Validation

1. Alignment of Default Locale and 'hosted.defaultCountry' for Phone Validation Users

Any numbers that do not have country codes will be set to the Default Locale.

For instance, when users perform phone validation with Australia as the default country:

Locale: AUSTRALIA

hosted.defaultCountry: AU.

Numbers from non-Australian countries/locale will still be processed if they contain country codes prefix eg '+##'.

Similarly, for users conducting phone validation with New Zealand as the default country:

Locale: NEW ZEALAND

hosted.defaultCountry: NZ.

Numbers from non-Australian countries/locale will still be processed if they contain country codes prefix eg '+##'.

2. Guidance on Reviewing guides

After completing the necessary and configurations for PDPS provided in , the system is prepared for phone and email validation runs through both Harmony Batch System and Harmony WS.

Phone validation users are advised to synchronize the 'Locale' parameter set in Harmony Batch System or Harmony Webservices with the configuration. This alignment ensures seamless operation. The 'hosted.defaultCountry' parameter defines the default country for validation.

This alignment ensures accurate validation processes according to the specified country settings. For further clarification on 'hosted.defaultCountry', please refer details provided in

It is advisable to review the section, which provides explanations on phone validation and email validation enriched information. Prioritizing this section before examining the detailed sample illustrations in the following pages is recommended.

Refer / for an illustration of sample batch run.

Refer / for an illustration of sample webservice calls.

Loqate Harmony APIs Email Validation see API Specification
Loqate Harmony APIs Phone Validation see API Specification.
Prerequisites
Phone and Email PDP Configuration Setup
Prerequisites
Phone and Email PDP Configuration Setup
Guides
Phone Validation using Harmony Batch System
Email Validation using Harmony Batch
Phone Validation using Harmony WS
Email Validation using Harmony WS
hosted.defaultCountry
Default Country for Phone Validation.