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

Field

Description

uniqueReference

A unique reference for the address. Will depend on the data set being used.

line1

Address Line 1

line2

Address Line 1

line3

Address Line 1

locality

Locality/Town/Suburb

province

Province/State/City

postalCode

Postal Code

provinceReferenceID

ReferenceID for the province (if applicable)

country

Country 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 ReferenceID

Code

New South Wales

AU-NSW

NSW

Queensland

AU-QLD

QLD

South Australia

AU-SA

SA

Tasmania

AU-TAS

TAS

Victoria

AU-VIC

VIC

Western Australia

AU-WA

WA

Australian Capital Territory

AU-ACT

ACT

Northern Territory

AU-NT

NT