Comment on page
User Derived Address
Using user input to infer subdwelling address component exists to assist the user journey with validation address information.
User derived address is a featureOption called 'userInferred' of Address Find functionality that is very powerful in using user input to infer an address sub-premise. We link any inference to a valid address and provide this information to you to decide how best to use it (see How do I know userInferred has been used?).
Any inference is a known subdwelling component in that our technology and lexical knowledge base recognises the sub-dwelling component and handles it appropriately.
User derived address alters the address options the end user selects because of the end users input to recognise sub-premise. This is very usefull
Without User derived
The unit information is not used because within the data no unit exists at this address. However, the end user is requesting a unit.
With User derived
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.
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" }
}
When a User Inferred 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",
...
}
]
}
For AU & NZ all of them.
For information of a sub-premise be inferred this information must match Loqates Lexical knowledge base. This contains wide range of lexicals such as units, shop, level, floor, suite and various shorthand abbreviations for subdwellings.
If you find one that doesn't work let us know and we will update our knowledge base.
Last modified 1mo ago