Connections
Connections are a core feature that securely link your users’ financial institutions to your app, allowing for real-time data synchronization. This guide will walk you through managing connections using the dashboard and API, while offering best practices for developers.
What is a Connection?
What is a Connection?
A Connection is created whenever a user links their financial institution with your app. It acts as a secure conduit to fetch and store account holder data (e.g., accounts, transactions, and enrich insights). Connections are tied to the User Object.
Pro Tip:
Interact with accounts and transactions through the User Object, not the connection itself, to ensure data integrity.
Connection States
Pre-init
The connection has just been created and is in the starting phase. It’s waiting to be initialized.
Init
The connection has completed the initial authorization process. This is a temporary status before moving to "Pending".
Pending
The connection is waiting to become active or to be validated. This status means the setup process is still ongoing.
Active
The connection is up and running. It means all steps have been completed successfully, and it’s now fully operational.
Invalid
The connection is not working due to a failure in one of the steps. It can be refreshed manually, and if it completes successfully, it will become "Active".
Revoked
The connection has been removed and is no longer active.
View connection states in the Connections section of the dashboard.
Actions on a Connection
Developers can manage connections using the following actions:
Refresh Connection
Use this action to fetch the latest data from the financial institution without creating a new connection. A job resource is triggered asynchronously to update account and transaction data.
Steps:
- Select the connection.
- Click Refresh to sync data.
- Track the progress in the Job History section.
Pro Tip:
Regularly refresh connections to keep your data up-to-date.
Purge Connection
Removes all user data related to a specific financial institution.
When to use:
-
Before refreshing enriched data to ensure insights are accurate.
-
To securely delete sensitive user data.
Note
Always purge and refresh connections to ensure enriched insights reflect the latest data.
Revoke/Delete Connection
Permanently unlinks the financial institution. This action:
- Does not delete stored account or transaction data.
- Is irreversible.
When to use: When a user decides to disconnect their institution or when the connection is no longer needed.
Connection Profile Overview
When selecting a connection, the Connection Profile displays the following details:
Full Name
The name of the account holder.
Phone Numbers
Partially masked contact numbers.
Email Addresses
User's email addresses.
Physical Addresses
Associated address details.
Actions available in the connection profile:
-
Refresh Connection
-
Purge Connection
-
Revoke Connection
Note:
Data fetched from financial institutions includes PII (Personally Identifiable Information), which is partially masked in the dashboard for security.
Example Workflows
Refreshing a connection keeps your app in sync with the latest account and transaction data.
Steps:
- Select the connection.
- Click Refresh to fetch the latest data.
- Monitor progress in the Job History section.
Demo:
Updated about 1 month ago