Skip to main content
LEGACY GUIDEThis guide is for Platform API v2011101. For guidance on the newest version, see Connectivity Integration Guides.
In this guide, we cover the steps for connecting your end user’s account to retrieve account and routing number, account owner information, future balances, and account data and transaction history.
INFOThe Platform API is required for this use case. If you are a legacy client using the Nexus or Atrium API, the following information may not apply.
This guide uses our Connect Widget to gather end user’s credentials and fetch the appropriate data to enable your deposit account opening use case. Our Connect Widget captures the relationship between the end user and their financial institution and manages the connection while notifying you of major events using postMessages. We’ll use our Widget SDK to integrate the widget into your application; for more information on the Widget SDK, review our documentation. Your integration method depends on whether you’re building a web or mobile application. If you’re building a web application, use our Web Widget SDK and if you’re building a React Native application, use our React Native Widget SDK. If you’re using neither check out our Connect guides. To make this guide easier to follow, we don’t cover multifactor authentication (MFA) or OAuth. We have in-depth guides on how to manage MFA or OAuth depending on the product you’re using.

​
Before you Begin

Before you can you can use this guide, complete the following:
  • Sign up for the Client Dashboard.
  • Retrieve your client_id and api_key from the dashboard; you’ll need them to pass requests.
  • Whitelist your IP addresses.
  • Ensure all requests are using HTTPS with TLSv1.2 encryption or higher or else they will fail.
  • Get familiar with MX Bank, our test environment; MX Bank only allows specific test scenarios; and our guides follow these test experiences.
  • Work with your MX representative to enable the products required for your use case, which may include the following:
    • Account Aggregation
    • Instant Account Verification (IAV)
    • Account Owner Identification
    • Balance Checks