API Reference
Analytics
AppStore
API Reference
- GETList broker funder policies for current user
- PATCHBulk update broker funder policies
- GETExport broker funder policies as Excel
- POSTAdd a funder to broker's policies
- DELRemove a funder from broker's policies
- POSTUpload funder policy file for parsing
- GETGet policy upload job status
- GETGet specific policy upload job
- GETList pending funder matches for a job
- POSTResolve a pending funder match
- POSTSkip a pending funder match
- GETList funder policy evaluations for an end user
- POSTSubmit an end user to a single funder
- POSTUpsert a funder submission
- GETGet funder submission status
- POSTTrigger a funder submission
- GETSearch funders by name
BrokerSubmissions
Categories
Credentials
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETList EndUsers with Summary Information
- GETGet duplicate end users for an end user
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id (sync)deprecated
- POSTDelete EndUser by heron_id or end_user_id (async)
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETGet EndUser processing status
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEnrichers
EndUserEntity
- GETGet the definitions for all end user entities
- POSTCreate an end user entity
- GETExport all saved attribute for all end users to an Excel file
- 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
- PUTBulk save entity attribute values by entity name and attribute name
- POSTUpsert the attribute value for an end user entity attribute source
EndUserFiles
- GETAll EndUserFiles
- POSTProcess file without creating EndUserFile record
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- GETGet file rename rule variable slugs
- PATCHUpdate a file rename rule
- GETGet a single end user file by Heron ID
- DELDelete an EndUserFile
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- 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
- PATCHUpdate Parsed Results
- GETGet EndUserFiles
- POSTPost EndUserFiledeprecated
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
- POSTPost EndUserFile V2
- POSTStart Workflow
FileClass
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETGet EndUser debt candidates
- 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
EndUserIntegrations
- POSTUpload DecisionLogic XML
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- GETGet single PDF by heron_id
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
- POSTUpdate PDF currency
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
- PUTRefresh assets reports for integration links
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
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)
- POSTReprocess a single ISO application
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
Rules
ParsedEndUserSubmission
UserMerchantGroups
Users
Webhooks
Start Workflow
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/start_workflow \
--header 'x-api-key: <api-key>'{
"success": true
}EndUserFiles
Start Workflow
Starts your configured Heron workflow for an end user
POST
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
start_workflow
Start Workflow
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/start_workflow \
--header 'x-api-key: <api-key>'{
"success": true
}Documentation Index
Fetch the complete documentation index at: https://docs.herondata.io/llms.txt
Use this file to discover all available pages before exploring further.
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.