Get EndUser transaction data coverage

GET

api

end_users

{end_user_id_or_heron_id}

transaction_data_coverage

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transaction_data_coverage \
  --header 'Authorization: Basic <encoded-value>'

{
  "by_account": {},
  "end_user_heron_id": "<string>",
  "reconciliation_by_account": {}
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

end_user_id_or_heron_id

string

required

Query Parameters

end_date

string

required

start_date

string

required

Response

200 - application/json

by_account

object

required

by_account.{key}

object[]

by_account.{key}.account_number

string

required

by_account.{key}.data_source_type

string

required

by_account.{key}.ranges

object[]

required

by_account.{key}.ranges.end_date

string

required

by_account.{key}.ranges.has_coverage

boolean

required

by_account.{key}.ranges.start_date

string

required

by_account.{key}.ranges.data_source_account

object

by_account.{key}.ranges.data_source_account.is_enabled

boolean

required

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

Example:

true

by_account.{key}.ranges.data_source_account.account_id

string

Unique account id associated with the data source account

Example:

"202348"

by_account.{key}.ranges.data_source_account.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

by_account.{key}.ranges.data_source_account.balances

object[]

List of balances associated with the account

Example:

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

by_account.{key}.ranges.data_source_account.currency

string

Currency of the account

Example:

"USD"

by_account.{key}.ranges.data_source_account.end_date

string

End date of the account

Example:

"2022-01-31"

by_account.{key}.ranges.data_source_account.heron_id

string

Unique ID for data source generated by Heron

Example:

"dso_VkXCAcNymkrsLYnhbH76dC"

by_account.{key}.ranges.data_source_account.institution_name

string

Name of the institution

Example:

"Chase"

by_account.{key}.ranges.data_source_account.max_date

string

Latest date of transactions associated with the data source account

Example:

"2022-01-31"

by_account.{key}.ranges.data_source_account.min_date

string

Earliest date of transactions associated with the data source account

Example:

"2022-01-01"

by_account.{key}.ranges.data_source_account.name

string

Name of the account

Example:

"Checking Account"

by_account.{key}.ranges.data_source_account.num_transactions

integer

Number of transactions associated with the data source account

Example:

120

by_account.{key}.ranges.data_source_account.number

string

Number of the account

Example:

"123456789"

by_account.{key}.ranges.data_source_account.owner_name

string

Name of the account owner

Example:

"John Doe"

by_account.{key}.ranges.data_source_account.reference_id

string

This is the account ID provided as part of the transaction

Example:

"account-202348"

by_account.{key}.ranges.data_source_account.start_date

string

Start date of the account

Example:

"2022-01-01"

by_account.{key}.ranges.data_source_account.transactions_match_balances

boolean

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

Example:

true

by_account.{key}.ranges.data_source_account.type

string

Type of the account

Example:

"Checking"

by_account.{key}.ranges.is_enabled

boolean | null

end_user_heron_id

string

required

reconciliation_by_account

object

required

Was this page helpful?

Request EndUser scorecard Get EndUser attribute values

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transaction_data_coverage \
  --header 'Authorization: Basic <encoded-value>'

{
  "by_account": {},
  "end_user_heron_id": "<string>",
  "reconciliation_by_account": {}
}

API Reference

Categories

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEntity

EndUserFiles

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

EnrichedTransactions

Transactions

Policy

Testing

Merchants

Rules

ParsedEndUserSubmission

Users

Webhooks

Get EndUser transaction data coverage

Authorizations

Path Parameters

Query Parameters

Response