Skip to main content
GET
Get a bank connection

Authorizations

Authorization
string
header
required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Path Parameters

id
string<uuid>
required

Response

The bank connection.

One authorisation with one bank. Several accounts can share a connection, and a workspace can hold several connections to the same bank.

object
string
required
Allowed value: "bank"
id
string<uuid>
required
name
string
required

The bank's name as the provider reports it.

Example:

"ING Bank"

country_code
string | null
required

ISO 3166-1 alpha-2 country of the bank.

Pattern: ^[A-Z]{2}$
Example:

"RO"

status
enum<string>
required

connected is working. loading is a sync in progress. requires_action needs a person to sign in or re-approve the connection in ThinkOut. error is any other failure. Only connected means the data behind it is current.

Available options:
connected,
loading,
requires_action,
error
last_sync_at
string<date-time> | null
required

When the provider last returned data successfully, or null. A connected connection with an old last_sync_at is the case worth alerting on.

When the bank consent needs renewal, if the provider reports it.

created_at
string<date-time>
required
updated_at
string<date-time>
required