A group is an association of 1 or more customers. It can be of type PERSONAL or BUSINESS

Example flow

1. Create customers A, B and C individually using Create Customer
2. Create a group with customers A, B and C using Create Group
3. Other customers can be added to the group later on using Add Customers to Group
4. Create Account 1 for this group using Creates an Account with accountHolderType = GROUP
5. Customer A creates a card for Group Account 1 with Create Card for Customer using the accountId of the group account
6. Customer C wants to create his own Individual Account 2 using Creates an Account with accountHolderType = CUSTOMER
7. Customer C creates a card for Individual Account 2 with Create Card for Customer using the accountId of the individual account

📘

Important points

A card must belong to an individual customer and linked to the group account.

There is currently no limit on the number of customers that can be added to a group.

A group should have a single account.

A group can have customers without cards, and they will still have access to the group account.

A group account can have multiple cards linked to it. All group account members have the same level of access to the account via their card.

Group operations

Create Group

Creating a group requires a minimum of one customerHayId but a list of customerHayIds can be passed in this request to include as many customers to the group as required.

Once the group is created successfully the API will respond with the groupHayId

Creates an Account

To be used with accountHolderType = GROUP. Creating an account for a group requires the groupHayId to be provided.

Add Customers to Group

Once a group has a groupHayId assigned to it in the system it can have additional customers added to that group that will have immediate access to any accounts linked to that groupHayId.

❗️

Access Controls

Our Group Accounts have a flat structure so all customers linked to the account have the same access and their is no specified notion of a primary owner or main account holder.

Example:

All parties linked to the account have the ability to request account closure without requiring consent from other account holders.