2. Register Users

Overview

The components can only be used by authenticated ByAllAccounts users. Users are registered in the ByAllAccounts system before they can access the Account Linking and Account Summary components from your application.

The registration method depends on user type:

• Investor users — Registered via the REST API.
• Advisor users — Registered via the DataConnect API.

Both registration calls return an internal identifier that you must save for the authentication step.

Instructions

🚧

Requirements

• ByAllAccounts Firm ID — Provided by your ByAllAccounts Implementation Manager during project setup.
• Unique Internal Identifier (optional) — Your application's own identifier for the user. Pass it via the firmTag1 parameter so the ByAllAccounts system retains a reference to how your platform identifies the user, alongside the ByAllAccounts identifier returned at registration.

Register investor users

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

Register advisor users

1. Create the advisor user with the DataConnect API <USERADDRQ> endpoint.
2. Save the <ID> value from the <USERADDRS> response.

👍

Success Criteria

Upon success, you will have a unique identifier for each newly registered user:

• Person Id for investors
• <ID> for advisors

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