​
Account Object

The Account object represents a financial account that exists at a bank, to which you have been granted access through user authorization.

​
Properties

​
id
string
required

Unique identifier for the account

​
bank
object
required
​
category
enum
required

The type of account. Can be one of: - cash - Represents real funds held by the institution - credit - Represents credit extended by the institution - investment - Represents investment accounts - other - Other account types

​
subcategory
enum
required

Further categorization of the account: - For cash: checking, savings, other - For credit: credit_card, line_of_credit, other - For investment or other: other

​
status
enum
required

The status of the account connection: - active - Account is connected and accessible - disconnected - Account has been disconnected - inactive - Account cannot be accessed

​
financialAddress
object
​
permissions
array

List of permissions granted for this account: - balances - Access to balance data - ownership - Access to ownership data - transactions - Access to transaction data

​
customer
object

​
Endpoints

​
Retrieve Account

Retrieves a single account by its ID.

POST /api/services/data/accounts/retrieve

Request

​
id
string
required

The ID of the account to retrieve

Response
{
  "id": "acc_12345",
  "bank": {
    "id": "bank_123",
    "name": "Example Bank"
  },
  "category": "cash",
  "subcategory": "checking",
  "status": "active",
  "financialAddress": {
    "type": "sortCode",
    "sortCode": {
      "sortCode": "123456",
      "accountNumber": "12345678"
    }
  },
  "permissions": ["balances", "transactions"],
  "customer": {
    "id": "cust_123"
  }
}

​
List Accounts

Returns a paginated list of accounts.

POST /api/services/data/accounts/list

Request

​
limit
number

Maximum number of accounts to return (default 10, max 100)

​
skip
number

Skip the first n accounts

Response
{
  "accounts": [
    {
      "id": "acc_12345",
      "bank": {
        "id": "bank_123",
        "name": "Example Bank"
      },
      "category": "cash",
      "subcategory": "checking",
      "status": "active",
      "financialAddress": {
        "type": "sortCode",
        "sortCode": {
          "sortCode": "123456",
          "accountNumber": "12345678"
        }
      },
      "permissions": ["balances", "transactions"],
      "customer": {
        "id": "cust_123"
      }
    }
  ],
  "hasMore": false
}

​
Refresh Account

Initiates a refresh for an account.

POST /api/services/data/accounts/refresh

Request

​
id
string
required

The ID of the account to refresh

Response
{
  "id": "acc_12345",
  "bank": {
    "id": "bank_123",
    "name": "Example Bank"
  },
  "category": "cash",
  "subcategory": "checking",
  "status": "active",
  "financialAddress": {
    "type": "sortCode",
    "sortCode": {
      "sortCode": "123456",
      "accountNumber": "12345678"
    }
  },
  "permissions": ["balances", "transactions"],
  "customer": {
    "id": "cust_123"
  }
}

​
Disconnect Account

Disconnects an account, revoking access to its data.

POST /api/services/data/accounts/disconnect

Request

​
id
string
required

The ID of the account to disconnect

Response
{
  "id": "acc_12345",
  "bank": {
    "id": "bank_123",
    "name": "Example Bank"
  },
  "category": "cash",
  "subcategory": "checking",
  "status": "active",
  "financialAddress": {
    "type": "sortCode",
    "sortCode": {
      "sortCode": "123456",
      "accountNumber": "12345678"
    }
  },
  "permissions": ["balances", "transactions"],
  "customer": {
    "id": "cust_123"
  }
}
Data SessionsAccount Holders