Introduction

The MX Platform API’s premium verification feature allows partners to retrieve the account and routing information in just a few simple steps. These are very similar to those for standard aggregation.

This guide will take you through the process of getting this information using both the Connect widget and purely through API endpoints. The Connect widget simplifies creating members and answering multi-factor authentication while providing a ready-made user interface for these verification steps. The general workflows you’ll follow depend on which method you want to use, but we’ll cover both.

Some important things to note:

If a verification is already running, a 202 Accepted status will be returned. If another aggregation-type process is already running — like standard aggregation or extended transaction history — a 409 Conflict will be returned.

For more information on aggregation-type processes more generally, as well as creating users and members, please see our comprehensive developer guides

Remember that verification is part of MX Platform API and you’ll need to follow its requirements. For important information on errors, standards and conventions, and the overall resource structure of the MX Platform API, please see our API reference or the guides above.

Workflow with the Connect widget

  1. Creating a user;
  2. Loading the Connect widget for that user;
    * The end user will use Connect to create a member, start a verification job, and answer multi-factor authentication if necessary;
  3. Listen for the event messages sent by the Connect widget and poll the member’s verification status until an end state is reached;
    * The Connect widget will deliver a member connected event message;
    * Polling the member status helps deal with cases where Connect is closed early or unexpectedly; a verification is successful when the member connection_status is CONNECTED and the is_aggregating field changes from true to false;
  4. Answer MFA, if necessary;
    * Connect will ask end users for all the information needed to manage the MFA process;
  5. If the verification is successful, reading the new member’s account numbers.

Workflow with API requests only

  1. Creating a user;
  2. Creating a member using the correct institution code and credentials required by that institution;
    * When a member is created, a standard aggregation is automatically started; this can be stopped with the skip_aggregation parameter;
  3. Calling the verify endpoint;
  4. Poll the member’s connection status;
  5. Answering MFA, if necessary;
  6. Answer the special account-selection challenge (the legacy flow skips this step and instead verifies all accounts);
  7. Poll the verification status until an end state is reached;
    • A verification is successful when the connection_status is CONNECTED and the the is_aggregating field changes from true to false;
  8. If the verification is successful, listing the new member’s account numbers.