Skip to main content

Connect Accounts

After users connect their accounts, you can retrieve financial data such as account balances, transaction history, account numbers, and more. To do this, integrate using either MX's Connect Widget or using only MX's Platform API.

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.

Sending Held Data

For financial institutions that have held data to share with MX, see Sending Held Data.

Creating Users

A user represents your end user in the MX system. There are two ways to create a user on the MX system:

To create a user with the Platform API, make a request to the Create User endpoint.

Best Practices

In this request, we recommend that you include:

  • A unique id of your choice. See Identifiers and Metadata.
  • metadata, such as the date the user was created or the end user's name. Don't include any sensitive information here, such as credentials.
  • A first name, last name, and email if the data is available. This data greatly improves analytics data and troubleshooting for support issues on specific users.

Next Steps

Use one of these guides based on the integration method you chose.