Update a data source account's account number

POST

api

data_source_accounts

{dsa_heron_id_to_update}

update_number

Update a data source account's account number

curl --request POST \
  --url https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "source_dsa_heron_id": "dsa_8w6V5CuRESc7G5yx3mXF54"
}
'

import requests

url = "https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number"

payload = { "source_dsa_heron_id": "dsa_8w6V5CuRESc7G5yx3mXF54" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({source_dsa_heron_id: 'dsa_8w6V5CuRESc7G5yx3mXF54'})
};

fetch('https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_dsa_heron_id' => 'dsa_8w6V5CuRESc7G5yx3mXF54'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number"

	payload := strings.NewReader("{\n  \"source_dsa_heron_id\": \"dsa_8w6V5CuRESc7G5yx3mXF54\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_dsa_heron_id\": \"dsa_8w6V5CuRESc7G5yx3mXF54\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_dsa_heron_id\": \"dsa_8w6V5CuRESc7G5yx3mXF54\"\n}"

response = http.request(request)
puts response.read_body

{
  "is_enabled": true,
  "account_id": "202348",
  "account_type": "business_checking",
  "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",
  "dba": "Chickys",
  "disabled_reason": "excluded_account_type",
  "disabled_reason_description": "Heron didn't load transactions because this workflow excludes business savings accounts.",
  "display_account_id": "7505",
  "end_date": "2022-01-31",
  "heron_account_suffix": "001",
  "heron_id": "dso_M4ER7exgAk4FVisGEDYEfd",
  "institution_name": "Chase",
  "max_date": "2022-01-31",
  "min_date": "2022-01-01",
  "name": "Checking Account",
  "num_transactions": 120,
  "number": "123456789",
  "owner_name": "John Doe",
  "printed_account_number": "1-458-1824-4066",
  "reference_id": "account-202348",
  "start_date": "2022-01-01",
  "transactions_match_balances": true,
  "type": "business"
}

Authorizations

x-api-key

string

header

required

Path Parameters

dsa_heron_id_to_update

string

required

Body

application/json

source_dsa_heron_id

string

required

The Heron ID of the data source account containing the number we want to update to

Example:

"dsa_8w6V5CuRESc7G5yx3mXF54"

Response

200 - application/json

is_enabled

boolean

required

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

Example:

true

account_id

string | null

PDF statement account identifier. Null for non-PDF sources.

Example:

"202348"

account_type

any | null

read-only

Heron's full account type, the same for every source: business_checking, business_savings, personal, escrow or credit_loan. Open-banking accounts get it only for checking and savings whose owner is known. Null when Heron can't tell.

Available options:

business_checking,

business_savings,

personal,

escrow,

credit_loan,

null

Example:

"business_checking"

anomaly_reasons

string[] | null

Reasons associated with anomaly_score for pdf bank statement account sources

Example:

[
  "Statement metadata changed",
  "Manual review flagged suspicious edits"
]

anomaly_score

integer

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

Example:

200

balances

object[]

List of balances associated with the account

Show child attributes

Example:

[
  {
    "closing_amount": 25000.45,
    "currency": "USD",
    "date": "2022-01-01"
  }
]

currency

string

Currency of the account

Example:

"USD"

dba

string | null

Doing Business As name printed on the bank statement

Example:

"Chickys"

disabled_reason

any | null

Why we never processed this account, so it was created disabled with no transactions: excluded_account_type (legacy or unknown account-type exclusion), excluded_personal_account, excluded_business_savings_account, excluded_escrow_account, excluded_credit_loan_account, loan_account, reviewer_excluded, not_an_account (an empty section of the document that is not an account, such as a summary box), excluded_bank (a bank or service provider the workflow skips), account_id_mismatch (the account number does not match the account_id sent on upload), or failed_checks (the statement was parsed but failed our checks, so the file was rejected). Null for every other account, including ones disabled later.

Available options:

excluded_account_type,

excluded_personal_account,

excluded_business_savings_account,

excluded_escrow_account,

excluded_credit_loan_account,

loan_account,

reviewer_excluded,

not_an_account,

excluded_bank,

account_id_mismatch,

failed_checks,

unverifiable_statement,

null

Example:

"excluded_account_type"

disabled_reason_description

string | null

read-only

Customer-facing explanation of why Heron did not process the account.

Example:

"Heron didn't load transactions because this workflow excludes business savings accounts."

display_account_id

string | null

Human-readable account label for display: the last four digits of the account number without heron_account_suffix (falling back to the account title). Not unique and not a key; join heron_id to data_source_account_heron_id on transactions.

Example:

"7505"

end_date

string<date>

End date of the account

Example:

"2022-01-31"

heron_account_suffix

string | null

Added by Heron to tell apart accounts that print the same account number, such as a checking account and its reserve line. Not printed by the bank. A 3-digit suffix is the order the accounts appear in one file, so the same account can get a different one in another file. Null when the printed number needed no suffix.

Example:

"001"

heron_id

string

Unique ID for data source generated by Heron

Example:

"dso_M4ER7exgAk4FVisGEDYEfd"

institution_name

string

Name of the institution

Example:

"Chase"

max_date

string<date>

Latest date of transactions associated with the data source account

Example:

"2022-01-31"

min_date

string<date>

Earliest date of transactions associated with the data source account

Example:

"2022-01-01"

name

string

Name of the account

Example:

"Checking Account"

num_transactions

integer

Number of transactions associated with the data source account

Example:

120

number

string

Number of the account

Example:

"123456789"

owner_name

string

Name of the account owner

Example:

"John Doe"

printed_account_number

string | null

The account number without heron_account_suffix: the number and any sub-account the bank printed. Same as number when there is no suffix.

Example:

"1-458-1824-4066"

reference_id

string

This is the account ID provided as part of the transaction

Example:

"account-202348"

start_date

string<date>

Start date of the account

Example:

"2022-01-01"

transactions_match_balances

boolean

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

Example:

true

type

string

Raw account type. Bank statements: business, personal or unknown. Open banking: the provider's own value, e.g. CHECKING, SAVINGS or Plaid's depository. Not the same across sources; use account_type to tell business checking from other accounts.

Example:

"business"

⌘I

Update a data source account's account number

curl --request POST \
  --url https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "source_dsa_heron_id": "dsa_8w6V5CuRESc7G5yx3mXF54"
}
'

import requests

url = "https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number"

payload = { "source_dsa_heron_id": "dsa_8w6V5CuRESc7G5yx3mXF54" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({source_dsa_heron_id: 'dsa_8w6V5CuRESc7G5yx3mXF54'})
};

fetch('https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_dsa_heron_id' => 'dsa_8w6V5CuRESc7G5yx3mXF54'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number"

	payload := strings.NewReader("{\n  \"source_dsa_heron_id\": \"dsa_8w6V5CuRESc7G5yx3mXF54\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_dsa_heron_id\": \"dsa_8w6V5CuRESc7G5yx3mXF54\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/data_source_accounts/{dsa_heron_id_to_update}/update_number")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_dsa_heron_id\": \"dsa_8w6V5CuRESc7G5yx3mXF54\"\n}"

response = http.request(request)
puts response.read_body

{
  "is_enabled": true,
  "account_id": "202348",
  "account_type": "business_checking",
  "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",
  "dba": "Chickys",
  "disabled_reason": "excluded_account_type",
  "disabled_reason_description": "Heron didn't load transactions because this workflow excludes business savings accounts.",
  "display_account_id": "7505",
  "end_date": "2022-01-31",
  "heron_account_suffix": "001",
  "heron_id": "dso_M4ER7exgAk4FVisGEDYEfd",
  "institution_name": "Chase",
  "max_date": "2022-01-31",
  "min_date": "2022-01-01",
  "name": "Checking Account",
  "num_transactions": 120,
  "number": "123456789",
  "owner_name": "John Doe",
  "printed_account_number": "1-458-1824-4066",
  "reference_id": "account-202348",
  "start_date": "2022-01-01",
  "transactions_match_balances": true,
  "type": "business"
}