Skip to main content

Address metadata retrieval

GET 
/v1/address/metadata

Required States: SUSPECT, PROSPECT, KYC_IN_PROGRESS or ACTIVE

The Address Metadata API is used to load the full metadata associated with an address selected from the Address Autocomplete API. The response content will vary dependent on the address type and the underlying address resolution service.

The resulting payload will consist of the following fields:

  • addressUType: The type of address object returned. In this case, it will always be paf.
  • simple: A simplified version of the address object. This will be null for PAF addresses.
  • paf: The full PAF address object.
    • addressLine: The full formatted address line.
    • dpid: Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier.
    • flatUnitType: Type of flat or unit for the address.
    • flatUnitNumber: Unit number (including suffix, if applicable).
    • floorLevelType: Type of floor or level for the address.
    • floorLevelNumber: Floor or level number (including alpha characters).
    • lotNumber: Allotment number for the address.
    • buildingName1: Building/Property name 1.
    • buildingName2: Building/Property name 2.
    • streetName: The name of the street.
    • streetType: The street type. Valid enumeration defined by Australia Post PAF code file.
    • streetSuffix: The street type suffix. Valid enumeration defined by Australia Post PAF code file.
    • postalDeliveryType: Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file.
    • postalDeliveryNumber: Postal delivery number if the address is a postal delivery type.
    • postalDeliveryNumberPrefix: Postal delivery number prefix related to the postal delivery number.
    • postalDeliveryNumberSuffix: Postal delivery number suffix related to the postal delivery number.
    • localityName: Full name of locality.
    • postcode: Postcode for the locality.
    • state: State in which the address belongs. Valid enumeration defined by Australia Post PAF code file.
  • purpose: The purpose of the address object. In this case, it will always be MAIL.

Request​

Responses​

OK

Last updated on