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.

Request 1: Australian Mobile Phone Number with Country Code

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"+61=mobile [phone]"
            }
        }
    }
}

Response 1: Validated Mobile Number

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "61",
            "countryCode": "61",
            "localNumber": "412345678",
            "phoneQuality": 7,
            "extraAttributes": {
                "MediaType": "61",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "Telstra"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Request 2: Australian Mobile Phone Number without Country Code

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"412345678"
            }
        }
    }
}

Response 2: Validated Mobile Number with Country Code

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "61",
            "countryCode": "61",
            "localNumber": "412345678",
            "phoneQuality": 7,
            "extraAttributes": {
                "MediaType": "61",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "Telstra"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Request 3: Australian Landline Number

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"0291234567"
            }
        }
    }
}

Response 3: Please note that the phone number validation process does not support the validation of Landline Numbers.

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "61",
            "areaCode": "2",
            "localNumber": "91234567",
            "phoneQuality": 8,
            "extraAttributes": {
                "exception": "Network is forbidden",
                "MediaType": "61",
                "phoneStatus": "indeterminate"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

NewZealand Number Validation

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

Request 4: New Zealand Mobile Number with Country Code

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"+64 ?(0)27 123 4567"
            }
        }
    }
}

Response 4: Validated Mobile Number.

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "64",
            "countryCode": "64",
            "localNumber": "271234567",
            "phoneQuality": 7,
            "extraAttributes": {
                "exception": "Validated as another country - NZ",
                "MediaType": "64",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "Spark New Zealand (ex. Telecom NZ)"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Non-Australian/New Zealand Number Validation

Please follow steps below.

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

• Activating Global Phone Validation configuration.

Request 5: International Number with Country code (United Kingdom Number)

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"AUSTRALIA"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"[phone]"
            }
        }
    }
}

Response 5: Validated International Number

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "locationInParties": 0,
        "containedInParties": false,
        "phone": {
            "countryCode": "44",
            "phoneQuality": 7,
            "localNumber": "1234567865",
            "extraAttributes": {
                "exception": "Validated as another country - GB",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "MNO - 3 (Hutchison 3G UK Ltd)"
            }
        }
    }
}

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

Request 1: New-Zealand Mobile Phone Number with Country Code

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"NEW_ZEALAND"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"+64 Fax ?(0)27 123 4567"
            }
        }
    }
}

Response 1: Validated Mobile Number

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "64",
            "countryCode": "64",
            "localNumber": "271234567",
            "phoneQuality": 7,
            "extraAttributes": {
                "MediaType": "64",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "Spark New Zealand (ex. Telecom NZ)"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Request 2: New-Zealand Mobile Phone Number without Country Code

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"NEW_ZEALAND"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"(0)27 123 4567"
            }
        }
    }
}

Response 2: Validated Mobile Number with Country Code

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "64",
            "countryCode": "64",
            "localNumber": "0271234567",
            "phoneQuality": 7,
            "extraAttributes": {
                "MediaType": "64",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "Spark New Zealand (ex. Telecom NZ)"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Request 3: New-Zealand Land Line Number

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"NEW_ZEALAND"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"[phone]"
            }
        }
    }
}

Response 3: Please note that the phone number validation process does not support the validation of landline numbers.

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "64",
            "areaCode": "9",
            "localNumber": "7001234",
            "phoneQuality": 8,
            "extraAttributes": {
                "exception": "Network is forbidden",
                "MediaType": "64",
                "phoneStatus": "indeterminate"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Australian Number Validation

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

Request 4: Australian Mobile Number with Country Code

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"NEW_ZEALAND"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"+61=mobile [phone]"
            }
        }
    }
}

Response 4: Validated Mobile Number.

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "phone": {
            "numberType": "61",
            "countryCode": "61",
            "localNumber": "412345678",
            "phoneQuality": 7,
            "extraAttributes": {
                "exception": "Validated as another country - AU",
                "MediaType": "61",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "Telstra"
            }
        },
        "containedInParties": false,
        "locationInParties": 0
    }
}

Non-Australian/New Zealand Number Validation

Please follow steps below.

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

• Activating Global Phone Validation configuration.

Request 5: International Number with Country code (United Kingdom Number)

{
    "harmonyServiceConfig": {
        "role": "HostedValRole",
        "locale":"NEW_ZEALAND"
    },
    "parserInput": {
        "rawDataInput": {
           
            "phoneNumber":
            {
            	"value":"[phone]"
            }
        }
    }
}

Response 5: Validated International Number

{
    "ciqPartyDocument": {
        "pdpchangeContext": {},
        "options": {
            "exposeAttributes": "7"
        },
        "locationInParties": 0,
        "containedInParties": false,
        "phone": {
            "countryCode": "44",
            "phoneQuality": 7,
            "localNumber": "1234567865",
            "extraAttributes": {
                "exception": "Validated as another country - GB",
                "phoneStatus": "connected|Network confirmed connection",
                "operatorName": "MNO - 3 (Hutchison 3G UK Ltd)"
            }
        }
    }
}