Get bank connection

Returns one bank Connection and its nested accounts. Pass an account’s accountId to link_account (source: "bank").

GET/v1/get_bank_connection

Query

Field	Type	Required	Default	Description
connectionId	string	Yes	—	Bank connection id from list_bank_connections.

Response `data`

Field	Type	Description
connectionId	string	Bank connection id.
institutionLabel	string	Display name of the linked institution.
status	string	Connection lifecycle status (active, error, paused).
provider	string	Aggregator provider id (e.g. pluggy, lunchflow).
region	string	Connection region bucket (br or other).
needsInitialSync	boolean	True while the first full sync is still running.
accounts	array	Snapshot accounts under this connection (see nested fields).
accounts[].accountId	string	Pass to link_account with source bank (same role as investment groupId).
accounts[].name	string	Account display label (custom name or kind index).
accounts[].accountKind	string	checking or credit.
accounts[].kindIndex	number	Index among accounts of the same kind on this connection.
accounts[].balance	number	Latest synced balance.
accounts[].currency	string	ISO 4217 currency code for the balance.

Request

curl --request GET \
  --url 'https://api.getliquify.com/v1/get_bank_connection?connectionId=conn_01' \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "data": {
    "connectionId": "conn_01",
    "institutionLabel": "Chase",
    "status": "active",
    "provider": "pluggy",
    "region": "other",
    "needsInitialSync": false,
    "accounts": [
      {
        "accountId": "link_01",
        "name": "checking 0",
        "accountKind": "checking",
        "kindIndex": 0,
        "balance": 1200,
        "currency": "EUR"
      }
    ]
  }
}

Query

Response data

Related

Response `data`