[ARCHIVE] Address to return in GetAccountDetails API

Archived 21/02/2024. Please see Representing Addresses

Question

In the Get Account Detail API response, is only the MAIL address required, or are both the REGISTERED and MAIL address required?

Answer

In the BankingAccountDetail schema, the addresses field is specified as an array of CommonPhysicalAddress. There is no requirement for a purpose type, as in CommonPhysicalAddressWithPurpose. The description of the addresses array notes that the addresses applicable for the account are "to be used for correspondence". If an address is not used for correspondence purposes it is excluded.

See:

• CDS BankingAccountDetail schema
• CDS CommonPhysicalAddress schema