2. Register Investor Users

Overview

The components can only be used by authenticated ByAllAccounts Investor users. Investor users are the account holders, who will be interacting with the Account Linking and Account Summary components to provide the necessary inputs to authenticate with a financial institution, link accounts, and aggregate the selected account data.

You will need to register these users using the REST API prior to giving them access to the components within your application.

Instructions

🚧

Requirements

• ByAllAccounts Firm ID
  • This Firm ID will be provided to you by your ByAllAccounts Implementation Manager during the Project Set-Up phase.
• Unique Internal Identifier (Optional)
  • This ID can be associated with the registered users in the ByAllAccounts system leveraging the firmTag1 parameter.
  • If specified, the value must be unique within the Firm to which the new Person is to be added. If not, HTTP 409 Conflict is returned.

1. Create investor users with the ByAllAccounts REST API POST /api/v1/persons endpoint.
2. Save the “Person Id” from the response.

👍

Success Criteria

Upon success, you will have a value for:

• Person ID for the newly registered user

You will need this ID to authenticate the investor user in the next step.