Mint a single-use signed browser URL to connect a new bank (30-min TTL), for yourself or, with for_user, for another member of the Workspace.

post/api/v2/connections/link

Request

  • Base URL: https://fintable.io
  • URL: https://fintable.io/api/v2/connections/link
  • Auth: HTTP bearer

Query parameters

workspace_idstring

Optional Workspace ID (ws_...) from GET /workspaces. Omit to act on the calculated default Workspace (the oldest one the person owns, otherwise the oldest one they belong to; is_default in GET /workspaces); omission returns validation_failed (422) only when the person belongs to no Workspace. Always a query parameter — on POST/PATCH/DELETE too; a body field never selects a Workspace. Unknown and unauthorized Workspace IDs return the standard not_found error.

Request body

institutionstring nullable

Institution slug from GET /institutions.

for_userstring email nullable

Email of another member of the Workspace who will open the link and sign in with their own Fintable login. Their role there must allow connecting banks and the credential's person must be able to manage their role (Owner: anyone; Admin: editors); anyone else is the same 422, so roles are never revealed. Omit, or name yourself, for a link the credential's own person opens.

Response

A {"data": {...}} envelope.

dataobject
workspace_idstring

Public ID of the Workspace this successful response was resolved against (workspace-bound endpoints only).

Changes

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