Inviting members

New account members join an account by accepting an invitation, either sent by email or delivered through your own flow.

Invitation process

The invitation process allows you to grant account access to new users.

When you invite someone to become an account member, they receive an email notification asking them to accept the invitation and bind their Swan user to their account membership, granting access to the account on which you invited them. With Swan's Web Banking, the invitation email is sent automatically; for API integrations, send it with the sendAccountMembershipInviteNotification mutation.

You can invite account members by phone number or by verified email. Use the API to add one membership or multiple memberships. If you use Swan's Web Banking interface, your users can invite members directly from the app.

Invitation flow:

1. A user with an account membership (the inviter) with the canManageAccountMembership permission creates a new account membership (for the invitee) using the API or Swan's Web Banking interface.
2. The new membership is created with the status ConsentPending or InvitationSent, depending on whether consent is required.
3. Swan sends an email invitation to the invited member (depending on your notification configuration).
4. The invited member clicks the link in the email, signs in or signs up to Swan, and accepts the invitation.
5. The user is bound to the account membership and the status changes to Enabled or BindingUserError.

Method	Explanation
Inviter provides phone number and email	Account member's mobile SIM card serves as the authentication factor. Account member can be assigned all membership permissions. Swan confirms the member's phone number during the sign-up process.
Inviter provides email only	Account member's verified email serves as the authentication factor. The membership isn't enabled until user verifies their email. Account member can only be assigned the canViewAccount and canManageCards membership permissions. Swan confirms the member's email during the sign-up process. Swan collects the user's phone number during the sign-up process so the member can perform sensitive operations such as initiating payments, ordering cards, and viewing sensitive card information.

Invitation sequence diagram

This sequence diagram depicts adding an account membership and binding the invitee to it with the API.

^{∗ The requester can be the account holder, the account's legal representative, or an account member with the canManageAccountMembership permission. The requester provides consent (diagram line 4).}