API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEntity
- GETGet the definitions for all end user entities
- POSTCreate an end user entity
- PATCHSet the display order of end user entities
- POSTCreate an end user entity attribute
- PATCHSet the display order of end user entity attributes
- DELDelete an EndUserEntityAttribute
- PATCHUpdate an end user entity
- POSTCreate an end user entity attribute
- POSTCreate an end user entity attribute source
- DELDelete an EndUserEntityAttribute
- PATCHUpsert an end user entity
- DELDelete an EndUserEntity
- PATCHUpdate an end user entity
- GETGet the materialised end user entities for an end user
- POSTUpsert the attribute value for an end user entity attribute source
EndUserFiles
- GETAll EndUserFiles
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
FileClass
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETRun industry classification on end user files
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
Users
Create EndUser
Create a new end user. If transactions have previously been sent for this end_user_id, use PUT end_users to update instead.
curl --request POST \
--url https://app.herondata.io/api/end_users \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"end_user": {
"end_user_id": "c512426d-2446-4309-9e43-ecc7bd1cb62b",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>"
}
}'{
"end_user": {
"confidence": 0.42,
"created": "2025-02-05T13:56:37.600538",
"criteria": [
{
"context": "higher_is_better",
"currency": "<string>",
"date_range": "last_180_days",
"description": "The number of unique transactions with a timestamp",
"group": "data_quality",
"label": "unique_transactions",
"status": "not_available",
"unit": "n",
"value": "<any>"
}
],
"data_sources": [
{
"status": "new",
"type": "pdf"
}
],
"end_user_id": "c512426d-2446-4309-9e43-ecc7bd1cb62b",
"heron_id": "eus_Hst7ppKnrRvKUyr7GTAbjH",
"is_portfolio": true,
"last_processed_at": "2025-03-19T13:56:37.600916",
"last_updated": "2025-03-19T13:56:37.600588",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
id defined by user; links to the end_user_id for transactions
1 - 140"c512426d-2446-4309-9e43-ecc7bd1cb62b"
Whether the end user is part of a lending portfolio
true
Name of end user; may help to improve categorisation accuracy
128"Company Name Inc."
Response
id defined by user; links to the end_user_id for transactions
1 - 140"c512426d-2446-4309-9e43-ecc7bd1cb62b"
Aggregated confidence for the end user across all transactions; between 0 and 1
0.42
When the end user was created in Heron system
"2025-02-05T13:56:37.600538"
List of scorecard metrics
Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value
higher_is_better, lower_is_better "higher_is_better"
The ISO currency code for metric, where applicable
Metric date range
latest, last_30_days, last_90_days, last_120_days, last_180_days, last_365_days, next_30_days, next_60_days, next_90_days, next_180_days, last_1_calendar_months, last_3_calendar_months, last_4_calendar_months, last_6_calendar_months, last_12_calendar_months, last_15_calendar_months, last_24_calendar_months, last_1_full_calendar_months, last_2_full_calendar_months, last_3_full_calendar_months, last_6_full_calendar_months, last_12_full_calendar_months, last_60_days, last_45_days, last_2_calendar_months "last_180_days"
Description of metric
"The number of unique transactions with a timestamp"
The type of metric
data_quality, processing_quality, balance, profit_and_loss, debt, risk_flag, forecast, heron, ml_feature "data_quality"
Metric label, slugified
"unique_transactions"
either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data
available, partially_available, not_available "not_available"
The unit of measurement for metric
n, day, ratio, amount, weekday, array, probability "n"
The metric value
List of data source summaries for the end user
Data source type
api, csv, pdf, integration_link, legacy, legacy_pdf, legacy_integration_link "pdf"
Status of the data source entity, where applicable (e.g. pdfs, integration links)
new, parsing, parsed, processed, human_reviewing, approved, rejected, failed, transactions_loaded, transactions_unloaded, pending, active, syncing, erroring, sync_disabled, deleted_in_plaid, unknown "new"
Unique id for end user generated by Heron
"eus_Hst7ppKnrRvKUyr7GTAbjH"
Whether the end user is part of a lending portfolio
true
When the end user was last successfully processed in Heron system
"2025-03-19T13:56:37.600916"
When the end user was last updated in Heron system
"2025-03-19T13:56:37.600588"
Name of end user; may help to improve categorisation accuracy
128"Company Name Inc."
Status of end user; 'ready' triggers async processing, 'review_requested' triggers manual review request
new, ready, processed, reviewed, review_requested, failed "ready"
Was this page helpful?
curl --request POST \
--url https://app.herondata.io/api/end_users \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"end_user": {
"end_user_id": "c512426d-2446-4309-9e43-ecc7bd1cb62b",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>"
}
}'{
"end_user": {
"confidence": 0.42,
"created": "2025-02-05T13:56:37.600538",
"criteria": [
{
"context": "higher_is_better",
"currency": "<string>",
"date_range": "last_180_days",
"description": "The number of unique transactions with a timestamp",
"group": "data_quality",
"label": "unique_transactions",
"status": "not_available",
"unit": "n",
"value": "<any>"
}
],
"data_sources": [
{
"status": "new",
"type": "pdf"
}
],
"end_user_id": "c512426d-2446-4309-9e43-ecc7bd1cb62b",
"heron_id": "eus_Hst7ppKnrRvKUyr7GTAbjH",
"is_portfolio": true,
"last_processed_at": "2025-03-19T13:56:37.600916",
"last_updated": "2025-03-19T13:56:37.600588",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}