Development Guide

📘

Helpful Context

We recommend reviewing Account Aggregation 101 to familiarize yourself with aggregation and ByAllAccounts Connect Suite to learn about the components.

✍️

Pre-requisites

Before you can get started with development and gain access to the ByAllAccounts platform, you will need to:

1. Contact ByAllAccounts Sales Team
2. Sign Non-Disclosure Agreement (NDA)
3. Sign Service Order (SO)
4. Sign Statement of Work (SOW)

Objective

This guide gives you the step-by-step information you need to develop a proof-of-concept implementation embedding the ByAllAccounts Connect Suite in your web application, so you can deliver an end-to-end account aggregation workflow seamlessly from your own platform.

The Connect Suite supports two distinct user types: investors, who link their own accounts, and advisors, who link their managed/book of business accounts. The integration steps are largely shared, and where they diverge, this guide branches into investor-specific and advisor-specific instructions.

Product Requirements for Integration

You will need to work with the following products to integrate account aggregation capabilities into your platform:

• Account Linking component
• Account Summary component
• REST API for investor aggregation
• DataConnect API for investor and advisor aggregation

📘

Integration Note

Embedding the Account Summary component is optional. Platforms can instead build their own account management experience using the REST API. Your Implementation Manager can help you evaluate the pros and cons of each approach and determine the right fit for your platform.

Developer Checklist

Follow these steps to integrate the Connect Suite into your application:

• 1. Get set up for access
• 2. Register users
• 3. Authenticate users
• 4. Configure headers for framing and OAuth
• 5. Download and install components
• 6. Incorporate the components into your parent page
• 7. Manage critical events
• 8. Test account linking
• 9. Collect aggregated data
• 10. Customize the user interface

🧰

Postman Collections

API calls referenced throughout this guide are available in two Postman collections:

• Investor Integration — REST and DataConnect calls for investor aggregation
• Advisor Integration — DataConnect calls for advisor aggregation

Before running any of the linked calls, configure your Postman environment with the credentials and IDs your Implementation Manager provided (admin login, admin password, Firm ID, etc.). Linked examples use environment variables like {{adminlogin}} and {{adminpw}} and will fail to authenticate if these are not set.

For DataConnect operations, use "Send and Download" and save the result to a .zip file. The XML response is inside.