Usage Info

This method provides access to all stored information about a Bank Account entity, including account type, routing information, and ownership details. Sensitive information like account numbers is masked by default but can be revealed when specifically requested. Use this method when verifying financial information or displaying account details for review purposes.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
bank_account_id	string	Yes	The ID of the Bank Account.
show_sensitive_data	object	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 Bank Account is the bank_account_number field.

Example

{
  "bank_account_id": "ba_6zNzQZHSf26V83BO3uW6dS",
  "show_sensitive_data": false
}

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 ID of the Bank Account.
bank_account_ownership_type	string	The type of ownership of the bank account. Must be one of the BANK_ACCOUNT_OWNERSHIP_TYPES .
bank_account_type	string	The type of bank account. Must be one of the BANK_ACCOUNT_TYPES .
bank_routing_number	string	The routing number that identifies the bank where the account is. This field must be 9 characters long and only contain digits [0-9].
bank_account_number	string	The account number for the bank account. This field must only contain digits [0-9].
bank_name	string	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.
created_at	string	The date-time when the 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 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_1mGNOxZNPCBqqplXUy54wh",
    "version": "2025-03-24"
  },
  "data": {
    "bank_account": {
      "bank_account_id": "ba_6zNzQZHSf26V83BO3uW6dS",
      "bank_account_ownership_type": "BUSINESS",
      "bank_account_type": "CHECKING",
      "bank_routing_number": "021000021",
      "bank_account_number": "XXXXXXX123",
      "bank_name": "JPMORGAN CHASE BANK, NA",
      "created_at": "2025-01-18T12:01:12.179Z",
      "updated_at": "2025-01-18T12:01:12.179Z"
    }
  }
}

Errors

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