Connect Widget Workflow
To aggregate multiple products in the Connect Widget:- Call the Request Widget URL endpoint and define the products you want to aggregate. This only starts the aggregation process, so in the next steps you’ll retrieve that aggregated data.
- Display this widget to the end user.
- Wait for the end user to connect to an institution and create a member.
- Verify aggregation is complete by polling the Read Member Status endpoint until
member_status.statusisCONNECTEDandproducts.last_updated_atis later than when you started the request. See Member Connection Statuses. - Fetch the aggregated data using one of the following endpoints:
- List Account Numbers by Member or List Account Numbers by Account
- List Account Owners by Member
- List Accounts or List Transaction by Account
- List Transactions by Member or use another
GETTransactions endpoint - Read Statement by Member or List Statements by Member
- List Holdings by Member or use another
GETInvestment Holdings endpoint
Accessing Priority Data
BETA FEATUREThe documentation is subject to change as updates are made.
- Reduce user drop-off during the connection flow
- Power time-sensitive workflows such as account verification or balance display
member_status.status is CONNECTED and products.last_updated_at is later than when you started the request.
Impact on Conversion
Specifying multiple products within thedata_request.products array restricts the selection to institutions that support all the specified services. This selective visibility ensures that users interact only with institutions capable of fulfilling their complete service requirements, enhancing the efficiency and success rate of connections.
Further benefits are:
- Streamlined Consent Process: By requesting all necessary permissions during a single OAuth flow, the consent process becomes more straightforward for users. This approach reduces the likelihood of user drop-off caused by complicated consent adjustments.
- Optimized Data Retrieval: Initializing all required products during the connection setup allows MX to commence data fetching immediately. This approach shortens the wait time for data availability and organizes the data retrieval process more efficiently, prioritizing the fetch sequence according to the integration needs.
Example Scenario
Suppose you configure the Connect Widget or API to require both Instant Account Verification (account_verification) and Account Owner Identification (identity_verification):
- Institution Availability: Only institutions that support both verification services will be displayed to the user. This filter prevents scenarios where a user attempts to connect with an institution that cannot provide the necessary services.
- OAuth Permissions: If the institution uses OAuth and supports configuring Account Owner data access as a separate permission, users must grant explicit consent for both services. Failure to do so triggers an error, prompting the user to revisit the OAuth flow and adjust their permissions. This ensures that all necessary data accesses are authorized from the outset.
Identifying Product Availability
To ensure the data is available for your desired institution, use theproducts[] query parameter in the List Institutions endpoint, or check the products field in the List Institutions and Read Institution responses.
