How to Request a Microdeposit
Request a Connect widget URL with the mode set to verification using the SSO API. When Connect is in verification mode, it will guide the end user through the best available verification method.
On the institution search screen, the Connect widget will by default display only financial institutions which support instant account verification. For end users who search for an institution that does not support instant account verification, the microdeposits flow will begin, and the end user will be presented with the option to verify using microdeposits.
When the microdeposit flow is used, no member will be created on the MX platform (though this may change in future versions). Partners must therefore log the microdeposit_guid and use it to load Connect in the correct configuration when the end user returns several days later to verify their deposit amounts. Loading with the correct microdeposit_guid ensures Connect will prompt for verification amounts and perform other tasks related to microdeposit verifications.
Configuration Options
The following configuration options are important when using microdeposits. mode is required and must be set to verification for microdeposits to function. ui_message_version is also required and must be set to 4.
| Configuration option | Data type | Description | Required? |
|---|---|---|---|
current_microdeposit_guid | String | This loads Connect to whichever step the microdeposit process is currently in, which may be the verify amounts step, an error state, etc. | Required if attempting to load a specific microdeposit for end users to enter amounts. |
mode | String | Loads the Connect widget into a specified mode; options are verification and aggregation. Defaults to aggregation. | Yes; must be set to verification. |
ui_message_version | Integer | Use this to specify which version of postMessage events are triggered. | Yes; must be set to 4. |