API Integration Checklist

Make your Platform API integration as seamless as possible with these checklists!

Getting Started

• Sign up for the Client Dashboard and your API keys
• Get your development-level client_id and api_key from the dashboard, and keep them secret and secure.
• Whitelist all IP addresses that will make requests to the API.
• Review our API Overview to learn more about standards, conventions, and security. Pay special attention to authentication and security (HTTPS, TLS, and API keys).
• Learn more about our test scenarios and development environment.
• Start from the beginning on each of our product guides to learn more about creating users and members.

Using the Connect Widget

Whether you're using aggregation or verification, determine the following information:

• Determine which method is the best option for you. We offer Connect Widget for the following:
  • Browser - Web Widget SDK
  • Mobile - React Native SDK
  • Mobile - Other
  • Hybrid
• If you're using our SDK, download it from our Github.
• Learn more about handling event messages:
  • Events Reference
  • How to Handle Events

Account Aggregation

We offer Account Aggregation using the Connect Widget or just API endpoints. Each guide will walk you through from creating a user, dealing with connection statuses, and multi-factor authentication.

Be sure to consult the API reference for specifics related to our aggregation and verification endpoints.

Also, check the Client Dashboard to keep track of success and error rates. For more information on aggregation metrics, review our Client Dashboard guide.

Instant Account Verification

We offer Instant Account Verification using the Connect Widget or just API endpoints. Each guide will walk you through from creating a user, dealing with connection statuses, and multi-factor authentication.

Be sure to consult the API reference for specifics related to our verification endpoints.

Also, check the Client Dashboard to keep track of success and error rates. For more information on aggregation metrics, review our Client Dashboard guide.

OAuth

For OAuth complete the following:

• Determine which type of integration matches your use case. We have an OAuth guide that describes how to handle OAuth for mobile application and browser-based applications.
• Keep in mind that all OAuth development and testing must be done with the MXCU (OAuth) or MX Bank (OAuth) test institutions; production institutions require prior registration.
• After testing, request production access.
• Fill out the OAuth registration form on the dashboard as soon as you request production access. For more information about OAuth in the Dashboard, review our Client Dashboard guides.

Webhooks

• Determine which type of webhook is required for your use case.
• Set up an appropriate callback URL for you to receive webhooks from MX. Find instructions for this in our Client Dashboard guides
• Create and configure a development webhook using your callback URL.
• Set up and configure production webhooks after requesting production access.

Contacting Support

Make sure to have the following information when making a support request, wherever applicable:

• Steps to replicate the issue.
• MX-defined GUIDs for any users or members associated with the request.
• Operating system information.
• Browser information.
• End-user screenshots or videos.

This video also has important information on using the MX support portal.

Going to Production

• Request production access on the dashboard.
• Get your production-level client_id and api_key and keep them secret and secure! These are different from your development-level ID and key.
• Fill out the OAuth registration form on the dashboard if necessary.
• Set up and configure production webhooks if necessary.
• Contact MX to ensure that all the necessary products and configurations have been enabled in the production environment.