Address Types

All addresses on the Aventus Platform follow a standard structure

{
      "uniqueReference": null,
      "line1": null,
      "line2": null,
      "line3": null,
      "locality": null,
      "province": null,
      "postalCode": null,
      "provinceReferenceID": null,
      "country": {
        "referenceID": null,
        "text": null
      }
}

Fields

FieldDescription
uniqueReferenceA unique reference for the address. Will depend on the data set being used.
line1Address Line 1
line2Address Line 1
line3Address Line 1
localityLocality/Town/Suburb
provinceProvince/State/City
postalCodePostal Code
provinceReferenceIDReferenceID for the province (if applicable)
countryCountry ListItem. This is a managed Aventus object.

Province

This is either free form or a managed list per country. Where a managed list is used, the provinceReferenceID must be provided.

See the individual values below for valid entries.

Australia

State List

State (Province)Province ReferenceIDCode
New South WalesAU-NSWNSW
QueenslandAU-QLDQLD
South AustraliaAU-SASA
TasmaniaAU-TASTAS
VictoriaAU-VICVIC
Western AustraliaAU-WAWA
Australian Capital TerritoryAU-ACTACT
Northern TerritoryAU-NTNT