Create Address

POST {{baseUrl}}/addresses

Creates one address. If such address already exists, the existing address will be returned.

Request Body

Body

KeyDatatypeMandatoryComments/ Constraints
blockstringNoSingapore only
buildingEstatestringsNoSingapore only
careOfstringNo
countryStringYesISO 3166 country code/name
idNumberYes
levelFloorstringNoSingapore only
postCodestringYes
stateStringYesIf country is Australia the value must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT'. Can also be 'Foreign' if country is not 'Australia'
unitFlatStringNoSingapore only

Request Body

{"streetLine1"=>"{{streetLine1}}", "suburb"=>"{{suburb}}", "state"=>"{{state}}", "postcode"=>"{{postcode}}", "country"=>"{{country}}"}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring

RESPONSES

status: Created

{"id":12345547,"streetLine1":"78 Test Road","suburb":"MELBOURNE","state":"VIC","postcode":"3000","country":"AUSTRALIA"}