v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUserDataSourceAccounts

Update a data source account

put/api/data_source_accounts/{heron_id}

Path parameters

heron_idstring required

Request body

is_enabledboolean

Whether or not the account is enabled. If disabled, hides related transactions from analytics

Example request

{
  "is_enabled": true
}

Response

account_idstring

Unique account id associated with the data source account

anomaly_reasonsstring[] nullable

Reasons associated with anomaly_score for pdf bank statement account sources

anomaly_scoreinteger

For pdf bank statement account sources, where the value is between 0 and 1000, with 1000 being the most anomalous

currencystring

Currency of the account

display_account_idstring nullable

Human-readable account label for display: the last four digits of the account number (falling back to the account title). Not unique and not a key; use account_id to join.

end_datestring date

End date of the account

heron_idstring

Unique ID for data source generated by Heron

institution_namestring

Name of the institution

is_enabledboolean required

Whether or not the account is enabled. If disabled, hides related transactions from analytics

max_datestring date

Latest date of transactions associated with the data source account

min_datestring date

Earliest date of transactions associated with the data source account

namestring

Name of the account

num_transactionsinteger

Number of transactions associated with the data source account

numberstring

Number of the account

owner_namestring

Name of the account owner

reference_idstring

This is the account ID provided as part of the transaction

start_datestring date

Start date of the account

transactions_match_balancesboolean

For pdf bank statements, represents whether all transactions extracted match the balances extracted

typestring

Type of the account

Example response

{
  "account_id": "202348",
  "anomaly_reasons": [
    "Statement metadata changed",
    "Manual review flagged suspicious edits"
  ],
  "anomaly_score": 200,
  "balances": [
    {
      "closing_amount": 25000.45,
      "currency": "USD",
      "date": "2022-01-01"
    }
  ],
  "currency": "USD",
  "display_account_id": "7505",
  "end_date": "2022-01-31",
  "heron_id": "dso_WMGNXUN2fgcGCmuYHykdgE",
  "institution_name": "Chase",
  "is_enabled": true,
  "max_date": "2022-01-31",
  "min_date": "2022-01-01",
  "name": "Checking Account",
  "num_transactions": 120,
  "number": "123456789",
  "owner_name": "John Doe",
  "reference_id": "account-202348",
  "start_date": "2022-01-01",
  "transactions_match_balances": true,
  "type": "Checking"
}