Retrieve a comprehensive list of all Bank Accounts associated with a specific Business entity.

POST http://api.kompliant.com/business.listBankAccounts (OpenAPI specification)

Usage Info

This method returns all bank account relationships for a specific Business, including detailed information about each account and its designated purposes within the business. Use this method when displaying financial information for review, selecting accounts for specific transactions, or performing comprehensive financial assessments of a business.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
business_id	string	Yes	The identifier for the Business from which to list all the Bank Account objects.
show_sensitive_data	boolean	No	A boolean value that if `true`, indicates that sensitive data should shown. If the parameter is not provided, the value defaults to `false` and the sensitive data will be masked. The sensitive data for the `business bank account` is dependant on the sub entity `bank_account`
verbose	boolean	No	A boolean value that when `true` includes the sub entities of the subject record in the response. The sub entity is `bank_account`

Example

{
  "business_id": "b_7eobHllxknr7mfqbjnX2Pp",
  "show_sensitive_data": true, 
  "verbose": true
}

Response

Data

Parameter	Type	Description
business_bank_accounts	array	An array of business bank account objects that contain information about bank accounts within the Business. If the Business has no Bank Accounts objects, the array will be empty.

Object Parameters

Parameter	Type	Description
business_bank_account_id	string	The ID of the Business Bank Account
bank_account_id	string	The Bank Account that is part of business.
bank_account_purposes	array	The list of purposes the bank account servers for the business. Must be one or more of the BANK_ACCOUNT_PURPOSES.
bank_account	object	An object containing the Bank Account entity information Requires verbose to be `true` to be displayed.
created_at	string	The date-time when the Business Bank Account was created. The value will be in ISO 8601 date and time format (`YYYY-MM-DDTHH:mm:ss.SSSZ`).
updated_at	string	The date-time when the Business Bank Account was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (`YYYY-MM-DDTHH:mm:ss.SSSZ`).

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_2h1MG0xRq9dPAPWLuygFk5",
    "version": "2025-03-24"
  },
  "data": {
    "business_bank_accounts": [
      {
        "business_bank_account_id": "bba_79HaMs4zgYfilF3xQuJy3J",
        "bank_account_id": "ba_6zNzQZHSf26V83BO3uW6dS",
        "bank_account_purposes": [
          "PRIMARY",
          "FEES",
          "SETTLEMENT"
        ],
        "created_at": "2025-01-18T15:36:03.547Z",
        "updated_at": "2025-01-18T15:36:03.547Z"
      },
      {
        "business_bank_account_id": "bba_2sChqaJ0VbgttIa9cxF04d",
        "bank_account_id": "ba_5xjhAK1APgCxyl7qqLtZFC",
        "bank_account_purposes": [
          "DISBURSEMENTS"
        ],
        "created_at": "2025-01-18T15:37:24.248Z",
        "updated_at": "2025-01-18T15:37:24.248Z"
      }
    ]
  }
}

Example with verbose

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_4S2V1NCjFJ9DYpEnLcdmdZ"
  },
  "data": {
    "business_bank_accounts": [
      {
        "business_bank_account_id": "bba_6h6N7gGsjN8AGRVWspoOel",
        "bank_account_id": "ba_6iVg9Mk7k7G1aKxYKmhM2q",
        "bank_account_purposes": [
          "PRIMARY"
        ],
        "created_at": "2025-09-04T17:13:13.198Z",
        "updated_at": "2025-09-04T17:13:13.198Z",
        "bank_account": {
          "bank_account_id": "ba_6iVg9Mk7k7G1aKxYKmhM2q",
          "bank_account_ownership_type": "BUSINESS",
          "bank_account_type": "GENERAL_LEDGER",
          "bank_routing_number": "021000021",
          "bank_account_number": "1234567819",
          "bank_name": "Chase Bank",
          "created_at": "2025-09-04T17:13:05.742Z",
          "updated_at": "2025-09-04T17:13:05.742Z"
        }
      }
    ]
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `business_id` provided does not exist.