---
title: "account/client-accounts"
method: GET
path: "/account/client-accounts"
tags: ["Client Account Management Endpoints"]
---

# account/client-accounts

`GET /account/client-accounts`

This endpoint returns a list of the available client accounts and some of its details.

It is also possible to filter the list of client accounts by ClientAccountID, its status (active or inactive), and client type (business, individual, receive-only).

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientType` string
- `AccountStatus` boolean
- `ClientAccountID` string
- `Label` string
- `Limit ` integer
- `Offset ` integer
- `SearchText` string

## Response `200`

- object
  - `Success` boolean — True if the request was successful, false if it failed
  - `ErrorMessage` string — Contains a description of the error if the request failed
  - `ClientAccounts` object — Collection of Client Accounts data
    - `0` object
      - `ClientAccountID` string — Client Account ID of the client account
      - `ClientType` string — Individual, Business or Receive-only
      - `ClientName` string — First and last name of the client
      - `EmailAddress` string, email — Client Account email address
      - `BusinessNumber` string — Client Account's business identifier.
      - `BusinessWebsite` string — Business website
      - `PhoneNumber` integer — Client Account's phone number
      - `BusinessIndustry` string — Business Industry name
      - `BusinessCategory` string — Business industry category name
      - `DOB` integer — Date of Birth, in date format YYYY-MM-DD (ex: 1960-01-15)
      - `SINLastDigits` integer — Last four digits of the client's SIN number
      - `IsActive` boolean — Flag that indicates whether the account is active or not
      - `VerificationStatus` object — Collection of verification status information
        - `Email` object
          - `Enhanced` string — verification status
          - `Basic` string — verification status
        - `Phone` object
          - `Enhanced` string — verification status
        - `Address` object
          - `Basic` string — verification status
      - `Address1` string — Client Account's main address information
      - `City` string — Client Account's city
      - `Province` string — Client Account's province specified using two character abbreviation (eg. BC, AB)
      - `Country` string — Client Account's country specified using full country name or ISO 3166-1 alpha-2 code
      - `Nationality` string — The Client's nationality
      - `PostalCode` string — Client Account's postal code
      - `IdentificationNumber` string — Client's ID (driver's licence or federal tax ID)
      - `ParentAccountID` string — Account ID of the account that created the client account
      - `Balances` object — Collection of Balances per available currency for the client account
        - `0` object
          - `Currency` string — Currency for the balance record
          - `Balance` string — The total balnace for the currency
          - `PendingBalance` string — The pending balance for the currency
      - `Labels` object — Collection of Labels associated with the client account
        - `0` object
          - `Label` string — The Label value
          - `LabelID` string — The ID of the label value
  - `Pagination` object — Pagination metadata
    - `TotalRecords` string — Total number of client account records in that search range.
    - `Offset` string — Use this parameter to set the starting point in the dataset.
    - `Limit` string — Limit the number of records that are returned.

---

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