---
title: "List categorized bank statement accounts"
method: GET
path: "/companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts"
tags: ["Bank statements"]
---

# List categorized bank statement accounts

`GET /companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts`

## Request

- Base URL: `https://api.codat.io`
- URL: `https://api.codat.io/companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/codatio/apis/lending/docs/companies/:companyId/reports/categorizedBankStatement/:reportId/accounts/get.ts> (a function with typed inputs; its response is checked against the schema)

The *Get categorized bank statement accounts* endpoint returns a list of bank accounts associated with categorized transactions for a company. 

Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`.

## Response `200`

OK

- CategorizedBankStatementAccounts: > **Categorization engine** > > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. The Enhanced Cash Flow accounts endpoint provides a list of accounts that categorized transactions have been taken from.
  - `results` object[]
    - `id` string: The ID of the account from the provider.
    - `sourceRef` object: A source reference containing the `sourceType` object "Banking".
      - `sourceType` string: The data source type.
    - `platformName` string: Name of the banking data source, e.g. "Plaid".
    - `accountProvider` string: The bank or other financial institution providing the account.
    - `accountName` string: The name of the account according to the provider.
    - `accountType` string: The type of banking account, e.g. credit or debit.
    - `currency` Currency (unresolved $ref)
    - `currentBalance` number: The balance of the bank account.
    - `identifiers` AccountIdentifiers (unresolved $ref)
  - `pageNumber` integer, required: Current page number.
  - `pageSize` integer, required: Number of items to return in results array.
  - `totalResults` integer, required: Total number of items.
  - `_links` Links, required (unresolved $ref)

## Other responses

- `400`: The request made is not valid.
- `401`: Your API request was not properly authorized.
- `402`: An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403`: You are using an outdated API key or a key not associated with that resource.
- `404`: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429`: Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500`: There is a problem with our server. Please try again later.
- `503`: The Codat API is temporarily offline for maintenance. Please try again later.

## Changes

- **2024-10-18** `d77786aca64c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/codatio/apis/lending/changes/companies/:companyId/reports/categorizedBankStatement/:reportId/accounts/get.md)

---

[API](https://skmtc.dev/codatio/apis/lending.md) - [All operations](https://skmtc.dev/codatio/apis/lending/llms.txt) - [OpenAPI document](https://skmtc.dev/codatio/apis/lending/revisions/c81b2fd3063d?raw)
