Skip to main content

Legacy Connectivity Guides

This section contains integration guides for legacy Platform API versions (before v20250224). These guides cover the essential workflows for connecting end users to their financial institutions and retrieving various types of financial data.

Important

If you're starting a new integration, follow the current connectivity guides for the most up-to-date instructions and best practices.

Integration Approaches

Your use case and technology determines which method of integration you should use. Use the following table to decide which integration method is the best for you.

MethodDescriptionWhen to Use
Connect WidgetThe Connect Widget is a pre-built, client-facing component that's presented to end users. It allows them to select and connect to their accounts.

You can use the Connect Widget for Web and Mobile applications. SDKs are available for Web and React Native.
You want to use our ready-made connection experience that handles:
  • Gathering end user’s credentials
  • Connecting to end user’s accounts to gather financial data
  • PostMessages for notification of status
  • OAuth (optional)
API OnlyUse API endpoints to connect to an end user's account and fetch data, using a non-MX UI connection experience.

You’ll have to manage connection statuses, webhooks, and more manually with this integration.
You want to build your own end-user facing connection experience instead of using our Connect Widget, or you’re looking to build a customized verification solution within your application.

Available Guides

Prerequisites

Before following any of these guides, ensure you have:

  • Signed up for Platform API access and obtained your development API keys from the MX Dashboard
  • Retrieved your client_id and api_key for authentication
  • Whitelisted your IP addresses
  • Configured all requests to use HTTPS with TLSv1.2 encryption or higher

Connect Widget Integrations

These guides use the Connect Widget to simplify the integration process with pre-built UI components and automatic connection management:

API-Only Integrations

These guides provide complete control over the user experience by using API endpoints directly:

Use Case Guides

These guides show how to build specific business use cases using MX connectivity products:

Deposit Account Opening

Verify identity, link funding accounts, and gather financial information when opening new deposit accounts:

Payment Verification

Verify account details, balances, and owner information before initiating payments via ACH, RTP, or FedNow: