Phone Validation using Harmony WS

This document provides instructions on utilizing the Harmony Restful WebServices for the Validation of phone numbers using Phone Validation PDPs in different locales.

API:

http://localhost:8080/HarmonyWS/rest/parseCustomerData

Role used in Harmony WebServices

Use the role detailed in PDP configuration setup.

Sample Request and Response for AUSTRALIA

1. Pre Reading

Please ensure that you have read and understood the rule when you are running phone validation using default country as Australia. Refer guidance on Alignment of Default Locale and 'hosted.defaultCountry' for Phone Validation Users.

2. Request Samples

Australian Number Validation.

chevron-rightRequest 1: Australian Mobile Phone Number with Country Codehashtag
{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"+61=mobile (04)12345678"
            }
        }
    }
}
chevron-rightResponse 1: Validated Mobile Numberhashtag
chevron-rightRequest 2: Australian Mobile Phone Number without Country Codehashtag
chevron-rightResponse 2: Validated Mobile Number with Country Codehashtag
chevron-rightRequest 3: Australian Landline Numberhashtag
chevron-rightResponse 3: Please note that the phone number validation process does not support the validation of Landline Numbers.hashtag

NewZealand Number Validation

Please note the number has to be presented in precise international number format (ITU E.123) prefix '+' followed by country code '+##'

chevron-rightRequest 4: New Zealand Mobile Number with Country Codehashtag
chevron-rightResponse 4: Validated Mobile Number.hashtag

Non-Australian/New Zealand Number Validation

Please follow steps below.

circle-info
  • Number has to be presented in precise international number format (ITU E.123) ,prefix '+' followed by country code '+##'.

chevron-rightRequest 5: International Number with Country code (United Kingdom Number)hashtag
chevron-rightResponse 5: Validated International Numberhashtag

Sample Request and Response for NEW_ZEALAND

1. Pre Reading

Please ensure that you have read and understood the rule when you are running phone validation using default country as New Zealand. Refer guidance on Refer guidance on Alignment of Default Locale and 'hosted.defaultCountry' for Phone Validation Users.

2. Request Samples

Please note that for all validated connected numbers the user will see the phone provider's name under operatorName JSON object.

New Zealand Number Validation

chevron-rightRequest 1: New-Zealand Mobile Phone Number with Country Codehashtag
chevron-rightResponse 1: Validated Mobile Numberhashtag
chevron-rightRequest 2: New-Zealand Mobile Phone Number without Country Codehashtag
chevron-rightResponse 2: Validated Mobile Number with Country Codehashtag
chevron-rightRequest 3: New-Zealand Land Line Number hashtag
chevron-rightResponse 3: Please note that the phone number validation process does not support the validation of landline numbers.hashtag

Australian Number Validation

Please note the number has to be presented in precise international number format (ITU E.123) prefix '+' followed by country code '+##'

chevron-rightRequest 4: Australian Mobile Number with Country Codehashtag
chevron-rightResponse 4: Validated Mobile Number.hashtag

Non-Australian/New Zealand Number Validation

Please follow steps below.

circle-info

  • Number has to be presented in precise international number format (ITU E.123), prefix '+' followed by country code '+##'.

chevron-rightRequest 5: International Number with Country code (United Kingdom Number)hashtag
chevron-rightResponse 5: Validated International Numberhashtag

Last updated