Create a connection
Use this endpoint to obtain a connect token, which can be used to initialize the Meld widget and start a bank linking connection.
Request body
When searching financial institutions via the Meld bank picker, filters the results based on whether or not the service provider will cause a redirect as part of account linking.
When false, will only include financial institutions which will not cause a redirect. When true, all financial institutions are included regardless of whether or not they may require a redirect. Default is true.
Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity.
Institution id to bypass the institution selection pane.
When searching financial institutions via the Meld bank picker, pre-populate the search string with this value
Set of products to load from the financial institution via the service provider if supported.
Can be empty as long as there is at least one required product specified. There must be at least one product specified somewhere for the connection to load some data.
Financial institutions do not need to support any of these products in order to be included in the Meld bank picker search results.
Set of products to load from the financial institution via the service provider after the connection is completed.
Can be empty as long as there is at least one optional product specified. There must be at least one product specified somewhere for the connection to load some data.
When searching financial institutions via the Meld bank picker, only those which support all of the selected products will be included. When empty, financial institutions will not be filtered by supported products.
Note: Each service provider handles products differently, and vary in which accounts they expose based on the inputted products.
For more details, reference Supported Products and the relevant Provider Details pages, e.g. Plaid
If provided, the url to redirect to after completing the service provider's widget flow
When searching financial institutions via the Meld bank picker, onlythose which service any of the regions provided will be included. A service region can be either an ISO 3166-1 alpha-2 country code or an ISO 3166-2 subdivision code. National financial institutions which service an entire country are included for the corresponding country when only subdivision regions are provided.
Example request
{
"externalCustomerId": "testUser"
}Response
Connect token was created