Banks

Start a new bank connection

Initiates a provider-specific connection flow. Returns a ConnectionStart payload the client renders — a Plaid Link token, a portal popup URL, or an OAuth redirect URL depending on the provider.

post/v1/banks/connections/start

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/banks/connections/start
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

providerInstanceIdstring required
emailstring email required
mobilestring
institutionIdstring
brandIdstring
countryCodesstring[]
redirectUristring
brokerageSlugstring
saltedgeConsentScopesstring[]
connectionType'read' | 'trade'
forceNewConnectionboolean

Response

Connection flow initiated

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.