Address International

These methods have been deprecated.

We recommend you upgrade your service to the latest Address Validation method. Upgrade at no cost and improved performance.

International address lookup methods

International address lookup methods take complete or partial address information as an input and perform a search against a given country other than Australia or New Zealand, returning address information that matches the search parameters.

find

Lookup international addresses using a single-line input address.

retrieve

Retrieve international address details using the result from international address lookup.

find

Lookup international addresses from a given country other than Australia/New Zealand using a single-line input address.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/intl/address/find

Or if using GET

    GET    https://hosted.mastersoftgroup.com/harmony/rest/intl/address/find

Request (POST)

The request body is an AddressRestRequest object:

The fullAddress attribute is required
The country attribute is required, its value should be an ISO 3166-1 alpha-2 country code.

     {
        "payload": [ { "fullAddress": "10 Downing Street", "country": "GB" } ]
    }

Request Parameters (GET)

The fullAddress parameter is required
The countryparameter is required, its value should be an ISO 3166-1 alpha-2 country code.

Response

The response body is an AddressRestResponse object:

       {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "10 Downing Street SomeCity, B63 3TA",
                "country": null,
                "postcode": null,
                "street2": null,
                "street": null,
                "streetNumber": null,
                "postal": null,
                "postalType": null,
                "postalNumber": null,
                "buildingName": null,
                "subdwelling": null,
                "attributes": null,
                "id": "GB|RM|A|123456",
                "district": null,
                "city": null,
                "province": null
            }
        ]
    }