---
title: "Get all account holders under a balance platform"
method: GET
path: "/balancePlatforms/{id}/accountHolders"
tags: ["Platform"]
---

# Get all account holders under a balance platform

`GET /balancePlatforms/{id}/accountHolders`

Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. 

For example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.

## Path parameters

- `id` string, required

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

OK - the request has succeeded.

- PaginatedAccountHoldersResponse
  - `accountHolders` AccountHolder[], required — List of account holders.
    - `balancePlatform` string — The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
    - `capabilities` object — Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
    - `contactDetails` ContactDetails
      - `address` Address, required
        - `city` string, required — The name of the city. Maximum length: 3000 characters.
        - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
        - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
        - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
        - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
        - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
      - `email` string, required — The email address of the account holder.
      - `phone` Phone, required
        - `number` string, required — The full phone number provided as a single string. For example, **"0031 6 11 22 33 44"**, **"+316/1122-3344"**, or **"(0031) 611223344"**.
        - `type` 'landline' | 'mobile', required — Type of phone number. Possible values: **Landline**, **Mobile**.
      - `webAddress` string — The URL of the account holder's website.
    - `description` string — Your description for the account holder, maximum 300 characters.
    - `id` string, required — The unique identifier of the account holder.
    - `legalEntityId` string, required — The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.
    - `metadata` object — A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
    - `migratedAccountHolderCode` string — The unique identifier of the migrated account holder in the classic integration.
    - `primaryBalanceAccount` string — The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
    - `reference` string — Your reference for the account holder, maximum 150 characters.
    - `status` 'active' | 'closed' | 'inactive' | 'suspended' — The status of the account holder. Possible values: * **active**: The account holder is active. This is the default status when creating an account holder. * **inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. * **suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. * **closed**: The account holder is permanently deactivated by you. This action cannot be undone.
    - `timeZone` string — The time zone of the account holder. For example, **Europe/Amsterdam**. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
    - `verificationDeadlines` VerificationDeadline[] — List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
      - `capabilities` string[], required — The names of the capabilities to be disallowed.
      - `entityIds` string[] — The unique identifiers of the bank account(s) that the deadline applies to
      - `expiresAt` string, date-time, required — The date that verification is due by before capabilities are disallowed.
  - `hasNext` boolean, required — Indicates whether there are more items on the next page.
  - `hasPrevious` boolean, required — Indicates whether there are more items on the previous page.

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `422` — Unprocessable Entity - a request validation error.
- `500` — Internal Server Error - the server could not process the request.

## Changes

- **2023-08-23** (v2) `5f5aad699185` — 2 info
  - added the optional property `accountHolders/items/capabilities/additionalProperties/problems/items/entity` to the response with the `200` status
  - added the optional property `accountHolders/items/capabilities/additionalProperties/problems/items/verificationErrors` to the response with the `200` status
- **2023-08-09** (v2) `ad8e1da0fe30` — 1 info
  - added the optional property `accountHolders/items/verificationDeadlines/items/entityIds` to the response with the `200` status

[Change history](https://skmtc.dev/adyen/apis/balanceplatformservice/changes/balancePlatforms/:id/accountHolders/get.md)

---

[API](https://skmtc.dev/adyen/apis/balanceplatformservice.md) · [All operations](https://skmtc.dev/adyen/apis/balanceplatformservice/llms.txt) · [OpenAPI document](https://skmtc.dev/adyen/apis/balanceplatformservice/revisions/78e297a2eb6f?raw)