DocsAPI Reference
Log In
API Reference

Create a connection

post
https://api-sb.meld.io/bank-linking/connect/start

Use this endpoint to obtain a connect token, which can be used to initialize the Meld widget and start a bank linking connection.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
accountPreferenceOverride
object

The account preference overrides for this connection

boolean

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.

string
required
length ≥ 1
Defaults to testUser

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity.

string

Institution id to bypass the institution selection pane.

string

When searching financial institutions via the Meld bank picker, pre-populate the search string with this value

optionalProducts
array of strings

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.

optionalProducts
products
array of strings
Defaults to TRANSACTIONS,IDENTIFIERS,BALANCES,OWNERS

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 <a href=https://docs.meld.io/docs/creating-connections#supported-products>Supported Products and the relevant Provider Details pages, e.g. <a href=https://docs.meld.io/docs/plaid>Plaid

products
string

If provided, the url to redirect to after completing the service provider's widget flow

regions
array of strings

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.

regions
string
Responses

400

Bad Request : check request values and format

401

Invalid credentials

403

Unauthenticated or authenticated with insufficient access

500

Server Error. This applies to all 5xx errors, including but not limited to 500, 501, 502, 503, and 504 errors. You should treat all of these errors the same.

Updated 7 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 7 months ago