Address Objects
We have three different types of objects suited to primary business regions being Australia, New Zealand and International (rest of world).
Last updated
We have three different types of objects suited to primary business regions being Australia, New Zealand and International (rest of world).
Last updated
We have three different types of objects suited to primary business regions being Australia, New Zealand and International (rest of world). However, if you need to integrate your global business need a set of universal objects.
We've created universal response components to enable consistent information no matter which address object best suits your business need.
When integrating to a platform we recommend using the universal response objects for consistency and scale.
See Address Field Mappings Guide for recommendations.
The AddressAu object is used when sending and receiving data from the address lookup API methods. For receiving data validated using Australian Sources of Truth (SoTs), see ValidatedAddressAu object.
Type: String
The Address type object for the returned response (e.g. 'AddressAu').
Type: String
The encrypted ID (e.g. 'fGBUVVdCntAu6wgNVcv0ePuSac7kAbUP').
Type: String
The concatenated address (e.g. 'SE 202 220 George St, Sydney, NSW 2000').
Type: String
Not currently implemented.
Type: String
The abbreviated State component of the address (e.g. 'NSW').
Type: String
The Postcode component of the address (e.g. '2000').
Type: String
The Locality component of the address (e.g. 'NORTH SYDNEY').
Type: String
The Street component of the address (e.g. 'GEORGE STREET').
Type: String
The Postal address (e.g. 'PO BOX 123').
Type: String
The Postal Number component of the Postal address (e.g. '123').
Type: String
The Postal Type component of the Postal address (e.g. 'PO BOX').
Type: String
The Street Number component of the address (e.g. '45A').
Type: String
The Street Name component of the address (e.g. 'GEORGE').
Type: String
The Street Type component of the address (e.g. 'STREET').
Type: String
The Street Suffix component of the address (e.g. 'E').
Type: String
The Building Name component of the address (e.g. 'ANZAC HOUSE').
Type: String
The Subdwelling component of the address (e.g. 'SE 202'). This includes subdwelling, floor, block and lot information.
Type: String
The Flat Unit Number component of the address (e.g. '7A').
Type: String
The Flat Unit Type component of the address (e.g. 'U').
Type: String
The Floor Level Number component of the address (e.g. '2').
Type: String
The Floor Level Type component of the address (e.g. 'FL').
Type: String
The Lot Number component of the address (e.g. '1').
Type: Map
A map of name/value pairs representing additional information from the Address in the Source of Truth (e.g. {"Longitude": "12.34", "Latitude": "12.34" }).
For example, sample attributes returned from "AUPAF" are shown below: {"Barcode":"1301012101021000002110322210012201313","Bsp":"015","DPID":"71230073"}
Sample attributes returned from "GNAF" are shown below: {"GNAFConfidence":"0","ParcelID":"1//DP75111","GNAFPointPID":"GANSW718616256", "MeshblockId":"10743811000","Latitude":"-33.86307089", "GNAFPID":"GANSW718616256","Longitude":"151.20781474", "GNAFReliability":"2","GNAFLocalityPID":"NSW3749", "GNAFGroupPID":"NSW2845405","GeocodeLevel":"7"}
Sample attributes are shown below, if "GNAF Plus" is active:
{"GNAFConfidence": "0","ParcelID": "CANB/BRAD/7/9/","GNAFPointPID": "GAACT718021569", "MeshblockId": "80003983000","Latitude": "-35.26134209", "GNAFPID": "GAACT718021569","Longitude": "149.13239137", "GNAFReliability": "2","GNAFLocalityPID": "ACT106", "GNAFGroupPID": "ACT346","GeocodeLevel": "7", "GNAFPIDPosition": "DOORSTOP","area_sqkm": "0.0468", "state_name": "AUSTRALIAN CAPITAL TERRITORY","state_code": "8", "lga_name": "UNINCORPORATED ACT","lga_code": "89399", "gcc_sa_name": "AUSTRALIAN CAPITAL TERRITORY","gcc_sa_code": "8ACTE", "ced_name": "FENNER","ced_code": "802", "sed_name": "KURRAJONG","sed_code": "80003", "sa1_code_7d": "8105118","sa1_code_main": "80105105118", "sa2_name": "BRADDON","sa2_code_main": "801051051","sa2_code_5d": "81051", "sa3_name": "NORTH CANBERRA","sa3_code": "80105", "sa4_name": "AUSTRALIAN CAPITAL TERRITORY","sa4_code": "801"}
The AddressNz object is used when sending and receiving data from the address lookup API methods. For receiving data validated using New Zealand Sources of Truth (SoTs), see ValidatedAddressNz object.
Type: String
The Address type object for the returned response (e.g. 'AddressNz').
Type: String
The encrypted ID (e.g. 'O4zqtEf98jsqhJwoNG+0S/DCFUGzuGGH').
Type: String
The concatenated address (e.g. '20 PANAMA STREET, WELLINGTON CENTRAL, WELLINGTON 6011').
Type: String
Not currently implemented
Type: String
The Postcode component of the address (e.g. '6011').
Type: String
The Town/City component of the address (e.g. 'WELLINGTON').
Type: String
The Suburb component of the address (e.g. 'WELLINGTON CENTRAL').
Type: String
The Street component of the address (e.g. 'PANAMA STREET').
Type: String
The Postal address (e.g. 'PO BOX 123').
Type: String
The Postal Number component of the Postal address (e.g. '123').
Type: String
The Postal Type component of the Postal address (e.g. 'PO BOX').
Type: String
The Street Number component of the address (e.g. '45A').
Type: String
The Street Name component of the address (e.g. 'PANAMA').
Type: String
The Street Type component of the address (e.g. 'STREET').
Type: String
The Street Suffix component of the address (e.g. 'E').
Type: String
The Building Name component of the address (e.g. 'ALBERT PLAZA').
Type: String
The Subdwelling component of the address (e.g. 'SE 202'). This includes subdwelling, floor, block and lot information.
Type: String
The Flat Unit Number component of the address (e.g. '7A').
Type: String
The Flat Unit Type component of the address (e.g. 'U').
Type: String
The Floor Level Number component of the address (e.g. '2').
Type: String
The Floor Level Type component of the address (e.g. 'FL').
Type: String
The Lot Number component of the address (e.g. '1').
Type: Map
A map of name/value pairs representing additional information from the Address in the Source of Truth (e.g. {"Longitude": "12.34", "Latitude": "12.34"}).
For example, sample attributes returned from "NZPAF" are shown below: {"ParcelId":"3996917","XCoordinate":"2658827", "MeshblockId":"2127500","YCoordinate":"5989553", "Latitude":"-41.287171091075614","Longitude":"174.7770385563209"}
The ValidatedAddressAu object is used when sending and receiving data from the address identify API methods using Australian Sources of Truth (SoTs).
Type: String
The Address type object for the returned response (e.g. 'ValidatedAddressAu').
Type: String
The encrypted ID (e.g. 'fGBUVVdCntAu6wgNVcv0ePuSac7kAbUP').
Type: String
The concatenated address (e.g. 'SE 202 220 George St, Sydney, NSW 2000').
Type: String
Not currently implemented.
Type: String
The abbreviated State component of the address (e.g. 'NSW').
Type: String
The Postcode component of the address (e.g. '2000').
Type: String
The Locality component of the address (e.g. 'NORTH SYDNEY').
Type: String
The Street component of the address (e.g. 'GEORGE STREET').
Type: String
The Postal address (e.g. 'PO BOX 123').
Type: String
The Postal Number component of the Postal address (e.g. '123').
Type: String
The Postal Type component of the Postal address (e.g. 'PO BOX').
Type: String
The Street Number component of the address (e.g. '45A').
Type: String
The Street Name component of the address (e.g. 'GEORGE').
Type: String
The Street Type component of the address (e.g. 'STREET').
Type: String
The Street Suffix component of the address (e.g. 'E').
Type: String
The Building Name component of the address (e.g. 'ANZAC HOUSE').
Type: String
The Subdwelling component of the address (e.g. 'SE 202'). This includes subdwelling, floor, block and lot information.
Type: String
The Flat Unit Number component of the address (e.g. '7A').
Type: String
The Flat Unit Type component of the address (e.g. 'U').
Type: String
The Floor Level Number component of the address (e.g. '2').
Type: String
The Floor Level Type component of the address (e.g. 'FL').
Type: String
The Lot Number component of the address (e.g. '1').
Type: String
The DPID or GNAFPID of the address (e.g. '89524889').
Type: String
The exception thrown from the backend.
Type: Map
A map of name/value pairs representing additional information from the Address in the Source of Truth (e.g. {"Longitude": "12.34", "Latitude": "12.34" }).
For example, sample attributes returned from "AUPAF" are shown below: {"Barcode":"1301012101021000002110322210012201313","Bsp":"015","DPID":"71230073"}
Sample attributes returned from "GNAF" are shown below: {"GNAFConfidence":"0","ParcelID":"1//DP75111","GNAFPointPID":"GANSW718616256", "MeshblockId":"10743811000","Latitude":"-33.86307089", "GNAFPID":"GANSW718616256","Longitude":"151.20781474", "GNAFReliability":"2","GNAFLocalityPID":"NSW3749", "GNAFGroupPID":"NSW2845405","GeocodeLevel":"7"}
Sample attributes are shown below, if "GNAF Plus" is active: {"GNAFConfidence": "0","ParcelID": "CANB/BRAD/7/9/","GNAFPointPID": "GAACT718021569", "MeshblockId": "80003983000","Latitude": "-35.26134209", "GNAFPID": "GAACT718021569","Longitude": "149.13239137", "GNAFReliability": "2","GNAFLocalityPID": "ACT106", "GNAFGroupPID": "ACT346","GeocodeLevel": "7", "GNAFPIDPosition": "DOORSTOP","area_sqkm": "0.0468", "state_name": "AUSTRALIAN CAPITAL TERRITORY","state_code": "8", "lga_name": "UNINCORPORATED ACT","lga_code": "89399", "gcc_sa_name": "AUSTRALIAN CAPITAL TERRITORY","gcc_sa_code": "8ACTE", "ced_name": "FENNER","ced_code": "802", "sed_name": "KURRAJONG","sed_code": "80003", "sa1_code_7d": "8105118","sa1_code_main": "80105105118", "sa2_name": "BRADDON","sa2_code_main": "801051051","sa2_code_5d": "81051", "sa3_name": "NORTH CANBERRA","sa3_code": "80105", "sa4_name": "AUSTRALIAN CAPITAL TERRITORY","sa4_code": "801"}
The ValidatedAddressNz object is used when sending and receiving data from the address identify API methods using New Zealand Sources of Truth (SoTs).
Type: String
The Address type object for the returned response (e.g. 'ValidatedAddressNz').
Type: String
The encrypted ID (e.g. 'O4zqtEf98jsqhJwoNG+0S/DCFUGzuGGH').
Type: String
The concatenated address (e.g. '20 PANAMA STREET, WELLINGTON CENTRAL, WELLINGTON 6011').
Type: String
Not currently implemented
Type: String
The Postcode component of the address (e.g. '6011').
Type: String
The Town/City component of the address (e.g. 'WELLINGTON').
Type: String
The Suburb component of the address (e.g. 'WELLINGTON CENTRAL').
Type: String
The Street component of the address (e.g. 'PANAMA STREET').
Type: String
The Postal address (e.g. 'PO BOX 123').
Type: String
The Postal Number component of the Postal address (e.g. '123').
Type: String
The Postal Type component of the Postal address (e.g. 'PO BOX').
Type: String
The Street Number component of the address (e.g. '45A').
Type: String
The Street Name component of the address (e.g. 'PANAMA').
Type: String
The Street Type component of the address (e.g. 'STREET').
Type: String
The Street Suffix component of the address (e.g. 'E').
Type: String
The Building Name component of the address (e.g. 'ALBERT PLAZA').
Type: String
The Subdwelling component of the address (e.g. 'SE 202'). This includes subdwelling, floor, block and lot information.
Type: String
The Flat Unit Number component of the address (e.g. '7A').
Type: String
The Flat Unit Type component of the address (e.g. 'U').
Type: String
The Floor Level Number component of the address (e.g. '2').
Type: String
The Floor Level Type component of the address (e.g. 'FL').
Type: String
The Lot Number component of the address (e.g. '1').
Type: String
The DPID or CNAR ID of the address (e.g. '2775942').
Type: String
The exception thrown from the backend.
Type: Map
A map of name/value pairs representing additional information from the Address in the Source of Truth (e.g. {"Longitude": "12.34", "Latitude": "12.34"}).
For example, sample attributes returned from "NZPAF" are shown below: {"ParcelId":"3996917","XCoordinate":"2658827", "MeshblockId":"2127500","YCoordinate":"5989553", "Latitude":"-41.287171091075614","Longitude":"174.7770385563209"}
The AddressIntl object is used when receiving data from retrieve API method for non-Australia and New Zealand addresses. It is also used when sending and receiving data from the previous version of International address lookup find and retrieve API methods.
Type: String
The Address type object for the returned response (e.g. 'AddressIntl').
Type: String
The full address (e.g. '805 Veterans Blvd Ste 305, REDWOOD CITY CA 94063-1737, UNITED STATES').
Type: String
The country component of the address (e.g. 'United States').
Type: String
The Province component of the address (e.g. 'CA').
Type: String
The Postcode component of the address (e.g. '94063-1737').
Type: String
The City component of the address (e.g. 'REDWOOD CITY').
Type: String
The Street component of the address (e.g. 'Veterans Blvd').
Type: String
The Street line 2 of the address.
Type: String
The Postal address (e.g. 'PO BOX 123').
Type: String
The Postal Number component of the Postal address (e.g. '123').
Type: String
The Postal Type component of the Postal address (e.g. 'PO BOX').
Type: String
The Street Number component of the address (e.g. '45A').
Type: String
The Building Name component of the address (e.g. 'ANZAC HOUSE').
Type: String
The Subdwelling component of the address (e.g. 'Lowr LEVEL'). This includes subdwelling, floor and block information.
Type: String
The District component of the address (e.g. 'Younus Colony').
Type: Map
A map of name/value pairs representing additional information of the Address. (e.g. {"DomesticId": "Z216947437", "Line1": "805 Veterans Blvd Ste 305"}).
For example: {"CountryIso2":"US","CountryIso3":"USA","DomesticId":"Z216947437","DataLevel":"Range","ProvinceName":"California", "Type":"Residential","Language":"ENG","LanguageAlternatives":"ENG","AdminAreaCode":"081", "ProvinceCode":"CA","CountryIsoNumber":"840","Line1":"805 Veterans Blvd Ste 305","AdminAreaName":"San Mateo"}
The AddressIntlV2 object is an AddressIntl with only non-null attributes are returned. It is used for receiving data from find API method, for all countries including Australia and New Zealand.
Type: String
The Address type object for the returned response (e.g. 'AddressIntlV2').
Type: String
The full address (e.g. 'Unit 1-2, Bond Street Industrial Estate Mancunian Way Manchester, M12 6HW').
Type: String
The Address Id or a non-Address Id for further lookup (e.g. for United Kingdom, 'GB|RM|A|14405045' for Address Type and 'GB|RM|ENG|MANCHESTER---WAY-MANCUNIAN-ESTATE-BOND_STREET_INDUSTRIAL' for Street Type), for Australia with GNAF Source of Truth 'AU|GNAF|GANSW717802735' for Address Type.
Type: Map
A map of name and value pairs representing additional information of the Address, e.g.
{"Type": "Address"} for Address Type
{"Type": "Street", "subdwellings": "Manchester, M12 6HW - 2 Addresses"} for non-Address Type for non-Australia/New Zealand
{"Type": "Floor", "subdwellings": "4 Addresses"} for non-Address Type for Australia/New Zealand
For Australia addresses with GNAF Source of Truth:
For United Kingdom addresses:
An array or list of Address (AddressAu or AddressNz) structures.