API

Methods

Objects

Back to current API

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 (refer to Address lookup for Australia/New Zealand), returning address information that matches the search parameters.

The API Specification, also available on each method below - it requires valid username and password.

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. Please try this demo for a list of supported countries.

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:


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

Request Parameters (GET)

Response

The response body is an AddressRestResponse object, which looks like below:


    {
        "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
            }
        ]
    }

retrieve

Retrieve international address details using the address id returned from the international address lookup.

Resource URL


    POST    https://hosted.mastersoftgroup.com/harmony/rest/intl/address/retrieve
Or if using GET 

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

Request (POST)

The request body is an AddressRestRequest object:

  • The id attribute is required

    {
        "payload": [ { "id": "GB|RM|A|123456" } ]
    }

Request Parameter (GET)

  • The id parameter is required

Response

The response body is an AddressRestResponse object:


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "Prime Minister & First Lord of the Treasury, 10 Downing Street, LONDON, SW1A 2AA, UNITED KINGDOM",
                "country": "United Kingdom",
                "postcode": "SW1A 2AA",
                "street2": "",
                "street": "Downing Street",
                "streetNumber": "10",
                "postal": "",
                "postalType": "",
                "postalNumber": null,
                "buildingName": "",
                "subdwelling": "",
                "attributes": {
                    ...
                },
                "id": "GB|RM|A|12345678",
                "district": "",
                "city": "London",
                "province": ""
            }
        ]
    }