Phone Validation

Takes one or more mobile phone numbers as an input and performs validation, returning a list of the results. The maximum number of input phone numbers is 100 per call.

Phone Validation Version 1.1

Takes one or more mobile phone numbers as an input and performs validation, returning a list of the results. The maximum number of input phone numbers is 100 per call.

Phone Validation coverage is global when full international number format (ITU E.123) is used. As example includes the '+' with the country code e.g. '[phone]' or '[phone]'.

See phone coverage to understand country coverage.

Changes from 16th October 2025: Phone validation was expanded to include landline and VoIP numbers, in addition to the current mobile phone validation for both business and personal use.

Added attributes: RequestProcessed, NumberType, PhoneNumber, NetworkCode, and IsValid.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/au/validate/phone

Request

The request body is a PhoneRestRequest object:

    {
        "payload": [ { "fullPhone": "0412345678", "country": "AU" } ]
    }
    

Response

The response body is a PhoneRestResponse object:

    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullPhone": "0412345678",
                "country": "AU",
                "countryCode": "61",
                "areaCode": "",
                "localNumber": "0412 345 678",
                "operatorName": "Vodafone Australia",
                "phoneStatus": "connected|Network confirmed connection",
                "exception": "",
                "attributes": {
                    "RequestProcessed": "true",
                    "NumberType": "Mobile",
                    "PhoneNumber": "[phone]",
                    "NetworkCode": "02",
                    "IsValid": "Yes"
                }
            }
        ]
    }
 

Response Elements

The response attributes are listed below. These are listed in the order expected when validating phones.

Element Name	Description	Example
fullPhone	The input phone number being validated.	0412345678
country	The ISO 3166-1 2-letter country code.	AU, NZ, GB, US
countryCode	Telephone number prefix.	+61
areaCode	No longer used as it is part of the localNumber.	null
localNumber	Local number is in the national format of the country,	0412 345 678
operatorName	Network name.	Vodafone Australia
phone Status	There are only three phone status returned. Connected - validated phone number and connected. Disconnected - validated number but not connected or cannot be reached. Indeterminate - number is invalid and returned error codes.	Connected|Confirmed Connection Disconnected|Network confirmed disconnection Indeterminate
exception	No longer used.	null
RequestProcessed	The request validation request has been processed.	true false
NumberType	The number type can be mobile, landline or VOIP and includes special numbers.	Mobile Landline VOIP
PhoneNumber	Input number with the country code prefix.	[phone]
NetworkCode	Network code assigned to the mobile provider.	03
IsValid	Yes - number is valid and connected. No - several cases: (1) valid number but disconnected; (2) not a valid number and network cannot be determined.	Yes No