Representing addresses

Introduction

Addresses are specified in a number of CDS schemas:

• CommonPAFAddress
• CommonPhysicalAddress
• CommonPhysicalAddressWithPurpose
• CommonSimpleAddress

Questions have arisen as to how addresses should be represented, and what values are appropriate for certain fields. Some of these questions are answered below, and in related articles.

CommonPhysicalAddressWithPurpose

The CommonPersonDetail schema requires an array of CommonPhysicalAddressWithPurpose objects. 

The schema description for this array states that this array requires at least one entry. However, if there is no physical address data available, this array may be returned empty. See Clarification of physicalAddresses in CommonPhysicalAddressWithPurpose.

Address Purposes

For an address that the Data Holder treats as the primary address, the purpose REGISTERED is preferred,. The enum PHYSICAL supports secondary addresses that represent an actual premise.
The enum OTHER is for cases where the actual type of address is unknown. 

Addresses enumerated as type OTHER should be shared, if they are addresses added by the customer for use by the Bank on behalf of that customer.

In the array of CommonPhysicalAddressWithPurpose objects, the standards require that no more than one address has a purpose of REGISTERED. The standards do not require that an address with a purpose of value REGISTERED is supplied. See Common physical address with purpose entries. 

CommonSimpleAddress

State field

Addresses in Australia

In an address schema, the state field in the CommonSimpleAddress schema is mandatory. For an address in Australia, this field must be filled from the enumeration of states and territories in Australia.

If a valid enumerated value cannot be provided for an address in Australia, the entire record is invalid. Neither an empty string or free form text is valid for an Australian address . The whole record must be omitted.

Addresses not in Australia

If the address is not in Australia, use free text to specify a state, county or other division. If there is no equivalent division, the state field can be returned with the value of an empty string (""). This is not the same as returning a null value, or not returning the field.

CommonPAFAddress

The CommonPAFAddress field, localityName could also be defined as suburb or town as Locality is a general term used by Australia Post to represent suburbs and town and location groups.

For further information on the Post Address File (PAF) see Australia Post - Address data for data partners.

Only Correspondence Addresses are required

In the BankingAccountDetail schema, the addresses field is specified as an array of CommonPhysicalAddress. This field is marked as optional which means that, if an address is not used for correspondence purposes, it can be excluded.