Expanded sub-premise reach

Expand your reach be enabling sub-premise reach feature to increases successful address finds to sub-premises not within our authoritative data.

What is Expanded sub-premise reach?

Increases your successful address searches for ungazetted sub-premises. These are commonly newly created developments, commercial addresses, retirement homes, land lease, shopping centers. These addresses are present in our authoritative data at a building or premise level, however, often the customer will request an address at their known sub-premise. This feature solves that issue by solving the last metres for successful delivery.

Our technology recognises the sub-premise has been requested for valid address and handles it appropriately.

How user derived address changes responses

Loqate AU NZ expanded sub-premise alters the address options the end user selects because of the end users input to recognise sub-premise.

Without expanded sub-premise

The unit information is not used because within the data no unit exists at this address. However, the end user is requesting a unit. If the customer selects the premise the end deliver can fail as the delivery driver does not know which sub-premise the deliver is for.

With expanded sub-premise

The unit information is now available for the end user to select as they have searched for it. Importantly, the premise level is what the validated address is linked with. The delivery driver has clear instruction to make the delivery.

How to Implement Expanded sub-premise

Add in call featureOptions "userInferred": "1". This is the only change you need to make. Address Retrieve works normally based upon the "id" supplied in Address Find.

    {
        "payload": [ { "country": "au", "fullAddress": "suite 4 20 bond st, nsw" } ], 
        "sourceOfTruth": "AUPAF",
        "featureOptions": { "userInferred": "1", "singleLineHitNumber": "5" }
    }

How do I know expanded sub-premise has been used?

When a expanded sub-premise has been selected in Address Find by the customer this confirms the inference eg That the end customer wants to use this address.

The Address id contains the UserInferred detail eg "AU|AUPAF|68930608|UNIT 2".

When calling Retrieve include this full ID containing the User inferred information.

Within the response data payload.attributes.UserInferred has the value of the userInferred input.

Population of this field

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
                ...
            "attributes": {
                 ...
                "UserInferred": "UNIT 5"
            },
            "id": "AU|AUPAF|68930608|UNIT 5",
        ...
        }
    ]
}

Which sub-premise types does it work for?

For AU & NZ all of them.

Our technology recognises the sub-premise patterns for valid address and handles it appropriately seamlessly in our api response.