Skip to main content

Secondary Users

A Secondary User is an individual who is able to successfully authenticate with the Holder and make changes to the account, but is not financially responsible and conducts actions as themselves (as opposed to on behalf of the account holder). To be a Secondary User for an account, a Secondary User Instruction from the account holder to treat the individual as a Secondary User must be in place.

Note

Secondary Users are different to Secondary User Instructions. Secondary Users relate to relationships with a secondary user type, whilst Secondary User Instructions relate to granting permission for a Secondary User to establish CDR Arrangements.

The HaaS Platform:

  • Does not manage Secondary Users.
  • Does manage Secondary User Instructions.
Note

Secondary Users are expected to succeed via the chosen authentication method and be associated with a Principal of their own.

Creating a Secondary User Instruction​

Once a Secondary User is defined by the Data Adapter, Secondary User Instruction are not automatically created. A Secondary User Instruction must be created by one of the mechanisms below:

  1. Consent Dashboard: An account holder is able to "enable" a Secondary User and thus create an Instruction for that Secondary User on an account (Note: Only possible if the Secondary User relationship is SECONDARY_USER).
  2. HaaS Manager: An admin user can "assign" a Secondary User to an account holder (see Manage Secondary User Instructions).

Managing a Secondary User Instruction​

Secondary User Instructions can be disabled and enabled by:

  1. An account holder via the Consent Dashboard (or using the Management API endpoint for customers implementing their own Consent Dashboard).
  2. An admin user via HaaS Manager, resulting in the Secondary User no longer able to share data from that account.
Note

A Secondary User Instruction exists until it is no longer returned from the Adapter. When a token is refreshed, HaaS will refresh and clean up its Secondary User knowledge by calling the Data Adapter List Banking/Energy Accounts endpoint to retrieve fresh data.

Secondary User Permissions and Limitations​

Secondary Users Can:

  • Share the same types of data as an account holder of the relevant account (i.e., account data, transaction data & product specific data), depending on the permissions set in the data sharing arrangement.
  • Initiate new data sharing arrangements.
  • Manage and revoke the data sharing arrangements they created.
  • Share data from a Joint Account if it is in a pre-approval state.

Secondary Users Can't:

  • Share customer specific information about the account holder/s (e.g., contact details).
  • Enable or disable other Secondary Users.
  • View, modify or revoke data sharing arrangements established by the account holder/s (i.e., they can't see or modify arrangements they did not create).
  • Manage or modify Joint Account settings.

In relation to Secondary Users, Account Holder/s Can:

  • View the sharing arrangements created by the Secondary User that relate to their account. However, they can't see individual accounts belonging to the Secondary User that are included in the data sharing arrangement. For example, if a Secondary User creates a sharing arrangement that includes both an account where they are a Secondary User and their own individual account, the account holder/s will only see the shared account for which the Secondary User role applies.
  • Enable and disable Secondary Users. When an account holder/s disables the Secondary User Instruction on an account, the account is removed from all arrangements created by the Secondary User.

Account Holder Restrictions and Secondary Users​

Vulnerable account holder​

A Secondary User can create a data sharing arrangement even when the account holder is flagged as vulnerable. Vulnerability never blocks creating an arrangement, it only changes how HaaS handles notifications and privacy settings. For more information, see Vulnerability β€” Vulnerability does not prevent data sharing.

HaaS does not maintain its own block register. Instead, the Data Adapter communicates restrictions by returning an HTTP 451 response (LegalBlock, CallCenterBlock, IneligibleBlock) from the Get User and List Accounts endpoints during the consent flow.

A 451 is scoped to the user and principal of that specific request β€” it is not evaluated at the account level. When returned, HaaS suppresses all accounts for that principal and displays a stop screen (see the consent-flow error mapping for Get User and List Accounts).

Because a Secondary User authenticates as themselves, using their own principal, any block applied to the account holder's principal does not automatically apply to the Secondary User. This is important because a secondary user may have their own separate accounts, so cascading the block would incorrectly suppress those unrelated accounts.

How to prevent a Secondary User from sharing a specific account

To prevent a Secondary User from sharing a specific account, the Data Adapter should remove that Secondary User's relationship to the account in the List Accounts accountCustomers response, rather than returning a 451 on the account holder. Removing the relationship:

  1. Prevents the account from being selected in new data sharing arrangements.
  2. Causes HaaS to disable the Secondary User Instruction for that account and revoke any existing active arrangements (and access tokens) the Secondary User holds for it.

Adapter Endpoints​

The following adapter endpoints are used to disclose Secondary User relationships within the accountCustomers response.

Get Banking Accounts​

Loading...

List Energy Accounts​

Loading...

Management Endpoints​

The following management endpoints are used to establish Secondary User Instructions which are attached to Secondary User relationships.

List Secondary User Instructions for an Account​

Loading...

Update Secondary User Instruction​

Loading...