Skip to main content
POST
/
bank-linking
/
connect
/
start
Create a connection
curl --request POST \
  --url https://api-sb.meld.io/bank-linking/connect/start \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalCustomerId": "testUser"
}
'
{
  "connectToken": "<string>",
  "customerId": "<string>",
  "externalCustomerId": "<string>",
  "id": "<string>",
  "widgetUrl": "<string>"
}

Authorizations

​
Authorization
string
header
default:BASIC <Meld API Key>
required

Body

application/json
​
externalCustomerId
string
default:testUser
required

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

Minimum string length: 1
Example:

"testUser"

​
accountPreferenceOverride
object

The account preference overrides for this connection

​
allowRedirect
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.

​
institutionId
string

Institution id to bypass the institution selection pane.

​
institutionSearchString
string

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

​
optionalProducts
enum<string>[]

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.

Available options:
BALANCES,
IDENTIFIERS,
INVESTMENT_HOLDINGS,
INVESTMENT_TRANSACTIONS,
OWNERS,
TRANSACTIONS
​
products
enum<string>[]

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

Available options:
BALANCES,
IDENTIFIERS,
INVESTMENT_HOLDINGS,
INVESTMENT_TRANSACTIONS,
OWNERS,
TRANSACTIONS
​
redirectUrl
string

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

​
regions
string[]

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.

Response

Connect token was created

​
connectToken
string

Connect token needed to go through the connect flow

​
customerId
string

Meld will create a new customer or use the existing customer based on the external customer id provided in the request. Keep track of this customer id for use in other endpoints and webhook tracking.

​
externalCustomerId
string

External id for the customer as provided in the request

​
id
string

Connection id

​
widgetUrl
string

Widget url to go through the connect flow