Start a bank connection (get the consent link)
Changed onStarts a bank connection for the authenticated user and returns the authorizationUri you must open in the user's browser so they can log into their bank and grant consent.
Flow: (1) call this with the providerId chosen from GET /bank/providers; (2) redirect/open the returned authorizationUri — the user authenticates and consents at their own bank (we never see their bank credentials); (3) after they return, call POST /bank/fetch, which confirms the consent and returns their transactions.
A pending connection record is stored immediately; it becomes active on the first successful fetch. providerId is required and must be chosen from the available bank directory. Only account-information read access is supported.
Request
- Base URLhttps://api.vocal.email/v1
- Auth
- API key in header X-API-Key
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
Connection started; redirect the user to authorizationUri
Example response
{
"data": {},
"success": true
}Changes
- breaking
request body became required
- breaking
the request property
became required
- breaking