Skip to main content
GET
Retrieve a bank account

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Path Parameters

bank_account_id
string
required

ID of the bank account.

Query Parameters

user
string<uuid>
required

ID of the user.

Response

200 - application/json
id
string

ID of the bank account.

user
string<uuid>

ID of the user associated with the bank account.

account_number_display
string

Display account identifier.

name
string

Account name.

type
enum<string>

Bank account type.

Available options:
checking,
savings,
cd,
moneyMarket,
creditCard,
lineOfCredit,
investment,
investmentTaxDeferred,
employeeStockPurchasePlan,
ira,
401k,
roth,
403b,
529plan,
rollover,
ugma,
utma,
keogh,
457plan,
401a,
brokerageAccount,
educationSavings,
healthSavingsAccount,
pension,
profitSharingPlan,
roth401k,
sepIRA,
simpleIRA,
thriftSavingsPlan,
variableAnnuity,
cryptocurrency,
mortgage,
loan,
studentLoan,
studentLoanGroup,
studentLoanAccount
aggregation_status_code
integer

Status code of the most recent aggregation attempt.

See Aggregation status codes.

status
enum<string>

Bank account status.

Available options:
pending,
active
institution
string

ID of the financial institution.

aggregation_success_date
string<date-time>

Timestamp (ISO 8601) of the last successful aggregation for the account.

aggregation_attempt_date
string<date-time>

Timestamp (ISO 8601) of the last aggregation attempt for the account, whether successful or not.

created_date
string<date-time>

Timestamp (ISO 8601) for when the bank account was created.

currency
string

Currency code.

institution_login
integer

ID of the institution login.

display_position
integer

Display position of the account at the financial institution.

parent_bank_account
string

ID of the parent bank account.

linked_account_date
string<date-time>

Timestamp (ISO 8601) for when the account was linked.

error_code
string

Bank connection error code.

error_message
string

Bank connection error message.

real_account_number_last4
string

Last four digits of the account number.

balance
number

Account balance amount. Returned as a number with up to two decimal places.

balance_date
string<date-time>

Timestamp (ISO 8601) for when the balance was recorded.

last_updated_date
string<date-time>

Timestamp (ISO 8601) for when the account was last updated.

market_segment
enum<string>

Indicates whether the account is personal or business.

Available options:
personal,
business
line_of_business
enum<string> | null
Coming soon

Indicates how the account is registered with the financial institution. Does not indicate how the account is used.

Available options:
personal,
business,
unknown
line_of_business_source
enum<string> | null
Coming soon

Source of the line_of_business value.

  • Financial_Institution indicates the value was provided by the financial institution.
  • Mastercard indicates the value was inferred using analytical models.
Available options:
Financial_Institution,
Mastercard
line_of_business_confidence_score
number | null
Coming soon

Confidence score for line_of_business, from 0 to 1.

A score of 1 is expected when the value is provided by the financial institution. Scores from 0.90 to 0.99 indicate high confidence, 0.60 to 0.89 indicate medium confidence, and 0.00 to 0.59 indicate low confidence.

Required range: 0 <= x <= 1
last_transaction_date
string<date-time>

Timestamp (ISO 8601) of the latest transaction.

oldest_transaction_date
string<date-time>

Timestamp (ISO 8601) of the oldest transaction.