Validate methods

Validate methods perform checks on input data and provide the results in the output.

email Performs a full mailbox validation on the supplied email address.
phone Performs a full validation on the supplied mobile phone number.
nzPropertyTitle Performs a ownership validation on the supplied geocoded single line/component addresses.

email

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

Resource URL


    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/validate/email
    

Request

The request body is an EmailRestRequest object:


    {
        "payload": [ { "address": "bob@example.org" } ],
        "sourceOfTruth": "VE_ALL"
    }
    

Response

The response body is an EmailRestResponse object:


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "address": "bob@example.org",
                "attributes":{"email_valid":"VALID","message":"Email verified."},                
                "mailBoxValidated": true,
                "mailServerValidated": true,
                "domainValidated": true,
                "blackListValidated": false,
                "formatValidated": false
            }
        ]
    }
    

phone

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.

Resource URL


    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/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": "",
                "areaCode": "",
                "localNumber": "0447569043",
                "operatorName": "Telstra",
                "phoneStatus": "Active",
                "exception":null
            }
        ]
    }
    

nzPropertyTitle

Takes an single line address or semi-structure address or latitude, longitude as an input and performs property ownership validation, return validated result as passed or failed.

Resource URLs


    POST(component)   	
    https://hosted.mastersoftgroup.com/harmony/rest/nz/validate/propertyTitle/component
    
    GET(component)   	
    https://hosted.mastersoftgroup.com/harmony/rest/nz/validate/propertyTitle/component?
    	firstName=John&lastName=Doe&streetNumber=000&street=xxx&suburb=MT EDEN
    	&townCity=ACUKLAND&postcode=1024
    
    POST(singleLine)
    https://hosted.mastersoftgroup.com/harmony/rest/nz/validate/propertyTitle/address
    
    GET(singleLine)   	
    https://hosted.mastersoftgroup.com/harmony/rest/nz/validate/propertyTitle/address?
    	firstName=John&lastName=Doe&fullAddress=000 xxxx st, wellington central, wellington
    	&showDetails=true
    	
    POST(latLong)   	
    https://hosted.mastersoftgroup.com/harmony/rest/nz/validate/propertyTitle/latlong
    
    GET(latLong)   		
    https://hosted.mastersoftgroup.com/harmony/rest/nz/validate/propertyTitle/latlong?
    	firstName=John&lastName=Doe&latitude=-41.xxxxxxx&longitude=174.xxxxxx
    	&showDetails=true

Request

The request body is a PropertyTitleRestRequest object:


   {
        "payload":{
        	"firstName":"John", 
        	"lastName":"Doe", 
        	"streetNumber":"000", 
        	"street":"xxxxx st", 
        	"suburb":"wellington central", 
        	"townCity":"wellington"
        	},
        "showDetails":"true"}
    }
    

Response

The response body is a PropertyTitleRestResponse object:


     {
        {
        	"status":"SUCCESS",
        	"messages":[],
       		 "payload":{
       		 	"response":"fail",
       		 	"attributes":[
       		 		{"type":"NZ_PROPERTY_TITLE",
       		 			"attributes":{
       		 				"guaranteeStatus":"Guarantee",
       		 				"status":"LIVE",
       		 				"descrption":"Fee Simple, 1/1, Lot x Deposited Plan xxx, 401 m2",
       		 				"spatialExtensShared":"T",
       		 				"ownsNumber":"1",
       		 				"issueDate":"1986/09/10 00:00:00",
       		 				"titleNo":"xxxx",
       		 				"type":"Freehold",
       		 				"owners":"xxxx",
       		 				"titleId":"xxxx",
       		 				"landDistrict":"Wellington"
   		 				}
	 				}
 				]
			}
		}
    }