Before you begin
- A connection has been created through Creating Connections
- A webhook profile is configured so you receive lifecycle events — see Webhook Quickstart
- Your backend has access to the customer’s
connectionIdorcustomerId
Steps
- Review the widget emitted events. These tell you when a connection has been successfully completed or if there was an error during the flow.
- Understand when your data is available. Different products are aggregated on different timelines, and webhooks indicate when each is ready.
- Once your data is available, retrieve your connection data. This covers balances, owners, identifiers, transactions, and investments.
- Review the connection statuses and errors. As connections move out of
ACTIVE, learn how to refresh, repair, or delete them in the next section.
Informing the user of the status
Endpoint quick reference
| Data | Endpoint | Reference |
|---|---|---|
| Balances / Owners / IDs | GET /bank-linking/financial-accounts | Retrieving Connection Data |
| Transactions | GET /bank-linking/transactions | Retrieving Connection Data |
| Investment Holdings | GET /bank-linking/investment-holdings | Retrieving Connection Data |
| Investment Transactions | GET /bank-linking/investment-transactions | Retrieving Connection Data |
| Connections metadata | GET /bank-linking/connections | Retrieving Connection Data |
Refer to the Bank Linking API reference for the complete request and response schema for each endpoint.