Nominated Representatives
Nominated Representatives in the HaaS environment allows for the Holder to designate users who have the ability to share data on behalf of a non-individual CDR Consumer (e.g. business, partnership).
Within the HaaS environment this is presented as a Principal/Profile Selector allowing a user to authenticate (and share data) in the context of the CDR Consumer for which they are a designated Nominated Representative.
Configurationβ
The Nominated Representatives source is determined based on the authoritative_source_nominated_representatives configuration setting:
| Value | Source of Nominated Representative relationship |
|---|---|
| WIKKIT_GATE | HaaS Manager |
| DATA_ADAPTER | List Accounts accountCustomers[].relationship with type of NOMINATED_REPRESENTATIVE |
HaaS Managerβ
Administering Nominated Representative relationships from HaaS Manager allows for standalone relationship management separated from the upstream data source.
Refer to View Nominated Representative Instructions, Add a Nominated Representative Instruction, Remove a Nominated Representative Instruction from the HaaS Administration guide.
If NOMINATED_REPRESENTATIVE relationships are found in the accountCustomers attribute returned by the relevant List Accounts endpoint, the account will be dropped from the List Accounts response as we do not expect the Data Adapter to return such relationships in this scenario.
Data Adapterβ
With the Data Adapter authoritative for Nominated Representatives, the userId is specified within accountCustomers[].relationship with a type of NOMINATED_REPRESENTATIVE.
The principalIds array in the relevant authentication response (Verify Login or Get User Principals) MUST also contain the Principal Identifier of the Non-Individual CDR Consumer.
If vulnerable is set to true, the account will be dropped from the response as the behaviour for vulnerable Nominated Representatives is undefined.
If the accountCustomer array contains a relationship value of NOMINATED_REPRESENTATIVE and a relationship value of SECONDARY_USER or SECONDARY_USER_PRIVATE the account will be dropped as Secondary User Instructions are only allowed for Individual Consumers and therefore cannot co-exist with Nominated Representative relationships.
Refer to List Banking Accounts or List Energy Accounts endpoint and guidance.