Usage Info

The Bank Account entity stores essential banking details including routing information, account numbers, and account types. These entities can be linked to a Business entity. Use this method when collecting financial information during application processes or when updating payment information for existing relationships.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The Subject Record to add this Business to.
bank_account	object	No	The bank account parameter is defined in the table below.

Bank Account Parameters

Parameter	Type	Required	Description
bank_account_ownership_type	string	No	The type of ownership of the bank account. Must be one of the BANK_ACCOUNT_OWNERSHIP_TYPES .
bank_account_type	string	No	The type of bank account. Must be one of the BANK_ACCOUNT_TYPES .
bank_routing_number	string	Yes	The routing number that identifies the bank where the account is. This field must be 9 characters long and only contain digits [0-9]. The last digit is a check digit and must pass validation according to the ABA routing number validation algorithm. For details on the check digit calculation, please refer to: https://en.wikipedia.org/wiki/ABA_routing_transit_number#Check_digit
bank_account_number	string	Yes	The account number for the bank account. This field must only contain digits [0-9].
bank_name	string	No	The name of the bank. Note: Some workflows, such as the Business-Application-type workflow, will override this value by using the bank_routing_number to find the publicly available bank name.

Example

{
  "subject_record_id": "sr_57WfSCnafMnxDiWMKcy3EW",
  "bank_account": {
    "bank_account_ownership_type": "BUSINESS",
    "bank_account_type": "CHECKING",
    "bank_routing_number": "021000021",
    "bank_account_number": "1234567890123",
    "bank_name": "Chase Bank"
  }
}

Response

Data

Parameter	Type	Description
bank_account	object	The bank account parameter is defined in the table below.

Bank Account Parameters

Parameter	Type	Description
bank_account_id	string	The identifier for the Bank Account just created.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_3XsPP17u8mU3k29x944ygx",
    "version": "2025-03-24"
  },
  "data": {
    "bank_account": {
      "bank_account_id": "ba_6zNzQZHSf26V83BO3uW6dS"
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
ACCOUNT_CONFIGURATION_VIOLATION	400	Account configuration rule violations are described below.
BAD_REQUEST	400	Required parameters not provided. Invalid values provided. Enum value provided does not correspond to an available type.
ENTITY_NOT_FOUND	400	The `subject_record_id` provided does not exist.

Account Configuration Violations

When a ACCOUNT_CONFIGURATION_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Subject Record	MAX_BANK_ACCOUNT_LIMIT	The maximum number of bank accounts allowed per Subject Record has been reached. No additional bank accounts can be added.