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 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