---
title: "Get Accounts"
method: GET
path: "/data/v2/accounts"
tags: ["Accounts Raw Data"]
---

# Get Accounts

`GET /data/v2/accounts`

The Get Accounts endpoint retrieves a list of bank accounts that have been linked by a user via LinkSDK, identified by their entity_id.Each account object contains fields such as account_id, account status, currency, account_sub_type, account identifiers (such as IBAN, ACCOUNT_NUMBER, and NATIONAL_ID) and other data points related accounts. You can use the resulting account_ids to query additional financial data through other Lean APIs such as transactions, balances, beneficiaries, and other data APIs. **A step by step guide** [here](https://docs.leantech.me/docs/lean-open-finance-data-integration-guide).

## Query parameters

- `async` boolean
- `page` integer
- `size` integer
- `entity_id` string, uuid
- `meta` string

## Response `200`

OK

- AccountsRequestResultV2
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required — The status of the request
  - `results_id` string, uuid, required — The unique identifier for the request
  - `message` string, required — A message describing the status of the request
  - `meta` object, nullable — Meta information about the request
  - `timestamp` string, date-time, required — The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable — Granular status code
    - `status_additional_info` string, nullable — Additional information about the status
  - `refreshed_at` string, date-time, nullable — The datetime of when the data was refreshed
  - `type` string, nullable — The endpoint the original request was made to.
  - `data` AccountsData
    - `type` string, required — The endpoint the original request was made to.
    - `accounts` Account[], required — An array of accounts associated with the Entity.
      - `entity_id` string, uuid — The unique identifier for the entity. Provided as a UUID.
      - `account_id` string, uuid, required — The unique identifier for the account. Provided as a UUID.
      - `account_holder_name` string — The Account Holder Name is the name or names of the Account owner(s) represented at the account level
      - `account_holder_short_name` string — Short form of the account holder name
      - `status` 'DELETED' | 'DISABLED' | 'ENABLED' | 'PENDING' | 'PROFORMA' | 'UNSUPPORTED', nullable — The current status of the account. Indicating whether it is in active use or not.
      - `status_update_date_time` string, date-time, nullable — The datetime that the account status was updated.
      - `currency` string — The ISO 3 letter currency code
      - `account_type` 'PERSONAL' | 'BUSINESS' | 'UNSUPPORTED' — Specifies the type of account (PERSONAL or BUSINESS).
      - `account_sub_type` 'CHARGE_CARD' | 'CREDIT' | 'CURRENT' | 'EMONEY' | 'LOAN' | 'MORTGAGE' | 'PERSONAL_LOAN' | 'PREPAID' | 'SAVINGS' | 'CALL' | 'UNSUPPORTED' — Specifies the sub type of account i.e., product family group such as CURRENT, SAVINGS, SAVINGS and CREDIT
      - `nickname` string, nullable — The nickname for the account as set by the owner of the account. This name is known to the end-user
      - `description` string, nullable — Specifies the description of the account sub-type.
      - `opening_date` string, date, nullable — The date the account was opened.
      - `maturity_date` string, date-time, nullable — Maturity date of the account.
      - `account` AccountIdentification[] — A list of identifications for the account assigned by the Bank based on the Account Scheme Name
        - `scheme_name` 'PAN' | 'IBAN' | 'BBAN' | 'COMMERCIAL_REGISTRATION_NUMBER' | 'EMAIL' | 'MOBILE_NUMBER' | 'NATIONAL_ID' | 'IQAMA_NUMBER' | 'PASSPORT_NUMBER' | 'OTHER' | 'UNSUPPORTED' — The scheme name of the account identification value
        - `identification` string — The identification value for the account assigned by the Bank based on the Account Scheme Name.
        - `name` string — Account name
      - `servicer` Servicer
        - `scheme_name` 'BICFI' | 'OTHER' | 'UNSUPPORTED' — Servicer identification scheme name
        - `identification` string — Servicer identification code
    - `page` PageMetadata, required — Metadata about the current page of results
      - `number` integer, required — The current page being returned by the API
      - `size` integer, required — The page size requested
      - `total_elements` integer, required — The total number of elements in all pages
      - `total_pages` integer, required — The total number of pages retrievable
      - `sort` string[] — Sort parameters applied to the results

## Other responses

- `202` — Accepted (Asynchronous request) when async=true
- `400` — Bad Request
- `404` — Entity not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)