{
// Part of Country
"country": "AU", //Required in ISO-2 format.
// Part of Premise level data. Need at least one (usually streetNumber)
"streetNumber": "string", // Optional. Most commonly used in 99% addresses.
"buildingName": "string", // Optional.
"flatUnitNumber": "string", // Optional. Must use with flatUnitType
"flatUnitType": "string", // Optional. Must use with flatUnitNumber
"floorLevelNumber": "string", // Optional. Must use with floorLevelType
"floorLevelType": "string", // Optional. Must use with floorLevelNumber
// Part of Street level data
"streetName": "string", // Required. Must use with streetType
"streetType": "string", // Required. Must use with streetName
//Part of City level data
"suburb": "string", // Required. Known as City.
"postcode": "string", // Optional. Known as Zip or Postcode.
// Part of Province level data
"state": "string", // Required.
// Geocodes in wgs84 EPSG: 4326
"latitude": "string", // wgs84 EPSG: 4326
"longitude": "string" // wgs84 EPSG: 4326
}
Creating an address requires completion of the all the data levels being:
Premise level: One or many. Most common is streetNumber.
buildingName,
flatUnitNumber and flatUnitType,
floorLevelNumber, floorLevelType,
streetNumber
Street level: Completion of both parts is required.
streetName and streetType
City level: Suburb must be completed. Postcode is optional
suburb
postcode
Province level:
state has the same meaning as province.
Country level:
country in ISO2 format is required.
Response
The response plays back the submitted Address with status.