Get data sources

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_sources \
  --header 'x-api-key: <api-key>'

[
  {
    "created": "2025-10-15T20:46:06.392985",
    "data_source_accounts": [
      {
        "account_id": "202348",
        "anomaly_score": 200,
        "enabled": true,
        "max_date": "2022-01-31",
        "min_date": "2022-01-01",
        "num_transactions": 120,
        "transactions_match_balances": true
      }
    ],
    "heron_id": "dso_5wyzuujPEjanA3Z7hMR3Yq",
    "last_updated": "2025-11-26T20:46:06.393013",
    "reference_id": "pdf_9WsxCMqxQUBZ5hamv2Bewh",
    "type": "pdf",
    "is_enabled": true,
    "metadata": {
      "filename": "202348_JAN_2022.pdf",
      "status": "processed"
    },
    "status": "new"
  }
]

GET

api

end_users

{end_user_id_or_heron_id}

data_sources

Get data sources

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_sources \
  --header 'x-api-key: <api-key>'

[
  {
    "created": "2025-10-15T20:46:06.392985",
    "data_source_accounts": [
      {
        "account_id": "202348",
        "anomaly_score": 200,
        "enabled": true,
        "max_date": "2022-01-31",
        "min_date": "2022-01-01",
        "num_transactions": 120,
        "transactions_match_balances": true
      }
    ],
    "heron_id": "dso_5wyzuujPEjanA3Z7hMR3Yq",
    "last_updated": "2025-11-26T20:46:06.393013",
    "reference_id": "pdf_9WsxCMqxQUBZ5hamv2Bewh",
    "type": "pdf",
    "is_enabled": true,
    "metadata": {
      "filename": "202348_JAN_2022.pdf",
      "status": "processed"
    },
    "status": "new"
  }
]

Authorizations

x-api-key

string

header

required

Path Parameters

end_user_id_or_heron_id

string

required

Response

200 - application/json

created

string<date-time>

required

When the data source was created in Heron system

Example:

"2025-10-15T20:46:06.392985"

data_source_accounts

object[]

required

List of data source accounts associated with the data source

Show child attributes

data_source_accounts.is_enabled

boolean

required

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

Example:

true

data_source_accounts.account_id

string

Unique account id associated with the data source account

Example:

"202348"

data_source_accounts.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

data_source_accounts.balances

object[]

List of balances associated with the account

Show child attributes

data_source_accounts.balances.closing_amount

object

required

The closing balance for the day

Show child attributes

data_source_accounts.balances.closing_amount.amount

number

The amount of money

Example:

"1234.56"

data_source_accounts.balances.closing_amount.currency

string

The currency of the money

Example:

"USD"

Example:

25000.45

data_source_accounts.balances.currency

string

Currency of the balance

Example:

"USD"

data_source_accounts.balances.date

string<date>

Date of the balance

Example:

"2022-01-01"

Example:

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

data_source_accounts.currency

string

Currency of the account

Example:

"USD"

data_source_accounts.end_date

string<date>

End date of the account

Example:

"2022-01-31"

data_source_accounts.heron_id

string

Unique ID for data source generated by Heron

Example:

"dso_HHNCcgSJmM82ZDLQweZDsR"

data_source_accounts.institution_name

string

Name of the institution

Example:

"Chase"

data_source_accounts.max_date

string<date>

Latest date of transactions associated with the data source account

Example:

"2022-01-31"

data_source_accounts.min_date

string<date>

Earliest date of transactions associated with the data source account

Example:

"2022-01-01"

data_source_accounts.name

string

Name of the account

Example:

"Checking Account"

data_source_accounts.num_transactions

integer

Number of transactions associated with the data source account

Example:

120

data_source_accounts.number

string

Number of the account

Example:

"123456789"

data_source_accounts.owner_name

string

Name of the account owner

Example:

"John Doe"

data_source_accounts.reference_id

string

This is the account ID provided as part of the transaction

Example:

"account-202348"

data_source_accounts.start_date

string<date>

Start date of the account

Example:

"2022-01-01"

data_source_accounts.transactions_match_balances

boolean

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

Example:

true

data_source_accounts.type

string

Type of the account

Example:

"Checking"

Example:

[
  {
    "account_id": "202348",
    "anomaly_score": 200,
    "enabled": true,
    "max_date": "2022-01-31",
    "min_date": "2022-01-01",
    "num_transactions": 120,
    "transactions_match_balances": true
  }
]

heron_id

string

required

Unique ID for data source generated by Heron

Example:

"dso_5wyzuujPEjanA3Z7hMR3Yq"

last_updated

string<date-time>

required

When the data source was last updated in Heron system

Example:

"2025-11-26T20:46:06.393013"

reference_id

string

required

Unique ID to identify the data source

Example:

"pdf_9WsxCMqxQUBZ5hamv2Bewh"

type

enum<string>

required

Data source type

Available options:

api,

csv,

pdf,

integration_link,

legacy,

legacy_pdf,

legacy_integration_link

Example:

"pdf"

is_enabled

boolean

default:true

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

Example:

true

metadata

object

Metadata associated with the data source

Show child attributes

metadata.currency

string

Currency associated with the data source entity, where applicable (e.g. pdfs)

Example:

"USD"

metadata.filename

string

Name of the file uploaded, where applicable (e.g. pdfs)

Example:

"202348_JAN_2022.pdf"

metadata.integration_heron_id

string

Unique Heron ID associated with an integration

Example:

"itg_NvvwdxunyTN5rJCMBauXri"

metadata.integration_item_id

string

Unique item id associated with integration link data sources

Example:

"Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr"

metadata.last_successful_sync

string<date-time>

Last successful sync date associated with integration link data sources

Example:

"2025-11-26T20:46:06.392493"

metadata.notes

string

Notes associated with the data source entity, where applicable (e.g. pdfs)

Example:

"error with processing, 52 invalid transaction(s) extracted from statement"

metadata.parsing_version

string

Parsing version associated with the data source entity, where applicable (e.g. pdfs)

Example:

"1.0.0"

metadata.sub_type

string

Sub type of the data source entity, where applicable (e.g. integration links)

Example:

"transaction"

Example:

{
  "filename": "202348_JAN_2022.pdf",
  "status": "processed"
}

status

enum<string>

Status of the data source entity, where applicable (e.g. pdfs, integration links)

Available options:

new,

parsing,

parsed,

processed,

human_reviewing,

approved,

rejected,

failed,

transactions_loaded,

transactions_unloaded,

pending,

active,

syncing,

erroring,

sync_disabled,

deleted_in_plaid,

unknown

Example:

"new"

Get data source account summary Get email templates

⌘I

API Reference

AppStore

Categories

Credentials

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnrichers

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

Policy

Positions

EnrichedTransactions

Transactions

Funders

Testing

Merchants

Rules

ParsedEndUserSubmission

UserMerchantGroups

Users

Watermarks

Webhooks

Workflows

Authorizations

Path Parameters

Response