Heron home page
Search...
⌘K
Support
Dashboard
Dashboard
Search...
Navigation
Page Not Found
Documentation
API Reference
Heron
Dashboard
API Reference
Authentication
Errors
Webhooks
AppStore
GET
List available apps
Categories
GET
Get categories
CrmIntegrations
GET
List CRM Integrations
POST
Create a CRM integration
PATCH
Patch a CRM integration
EndUserDataSourceAccounts
POST
Update a data source account's account number
PUT
Update a data source account
EndUserDataSources
PUT
Update a data source
GET
Get data source account summary
GET
Get data sources
EmailTemplates
GET
Get email templates
POST
Create an email template
PATCH
Patch an email template
EndUsers
GET
Get EndUser emails
GET
List EndUsers
PUT
Update EndUser
POST
Create EndUser
GET
List EndUsers with Summary Information
GET
Get EndUser by heron_id or end_user_id
DEL
Delete EndUser by heron_id or end_user_id
GET
Get EndUser emails
GET
Get EndUser information
PATCH
Patch EndUser information
POST
Enrich transactions of EndUser
GET
Get EndUser physical location
GET
Retrieve CRM sync events for an end user
POST
Trigger a CRM Sync for an End User
EndUserEmails
GET
Export an end user email as an EML file
EndUserEnrichers
GET
Get all fields for all enrichers for a given user
POST
Trigger enricher execution for a specific end user
GET
Get enrichment results for an end user
GET
Get enricher result by enricher name and end user
EndUserEntity
GET
Get the definitions for all end user entities
POST
Create an end user entity
PATCH
Set the display order of end user entities
POST
Create an end user entity attribute
PATCH
Set the display order of end user entity attributes
DEL
Delete an EndUserEntityAttribute
PATCH
Update an end user entity
POST
Create an end user entity attribute
POST
Create an end user entity attribute source
DEL
Delete an EndUserEntityAttribute
PATCH
Upsert an end user entity
DEL
Delete an EndUserEntity
PATCH
Update an end user entity
GET
Get the materialised end user entities for an end user
POST
Upsert the attribute value for an end user entity attribute source
EndUserFiles
GET
All EndUserFiles
POST
Process file without creating EndUserFile record
GET
Get recent files by file class
GET
Get file rename rules
POST
Create a file rename rule
GET
Get file rename rule variable slugs
PATCH
Update a file rename rule
DEL
Delete an EndUserFile
PATCH
Update the end user file's class
GET
Get EndUserFile as a base64 string
POST
Trigger async parsing of an end user file
GET
Get parsed results from uploaded files
POST
Trigger file's rename rule
POST
Trigger splitting a combined end user file into its child files based on its page_classes
PATCH
Update Parsed Results
GET
Get EndUserFiles
POST
Post EndUserFile
GET
Download EndUserFiles
GET
Download xlsx of parsed results from uploaded files
FileClass
GET
Get all file classes
GET
Get current file classes used in classification
POST
Add a FileClass to Classify for a User
DEL
Remove a FileClass from Classification for a User
EndUserCalculations
GET
Get EndUser balance
GET
Get EndUser forecasts
GET
Get EndUser statistics
GET
Run industry classification on end user files
GET
Get EndUser anomalies
GET
Get EndUser bank statement summary
GET
Get EndUser metric benchmarks
GET
Get EndUser debt candidates
GET
Export as a spreadsheet
GET
Get EndUser transactions grouped by counterparty or merchant
GET
Get EndUser Heron Score (beta)
GET
Get EndUser merchant summary
GET
Get EndUser named dates
GET
Get EndUser cashflow P&L
PUT
Update EndUser P&L layout
GET
Get EndUser recurring transactions report
GET
Get EndUser scorecard
POST
Request EndUser scorecard
GET
Get EndUser transaction data coverage
EndUserAttributes
GET
Get EndUser attribute values
EnrichmentFeedback
POST
Bulk create category feedback for an end user
PUT
Create category, merchant feedback
EndUserFinancials
GET
Get EndUser's combined financials
EndUserRules
GET
Evaluate all rules for an end user
Integrations
POST
Send a Finicity Connect email to an end user
POST
Trigger a cashflow report generation for an end user
POST
Trigger a statement reports generation for an end user
POST
Trigger a Finicity VOE transactions report generation for an end user
PUT
Update an Integration Link
GET
List Integrations
POST
Create an integration
PUT
Update Integration
GET
Get IntegrationLinks by Integration
POST
Create an integration Link
DEL
(Soft-)Delete an integration link
POST
Refresh an IntegrationLink
EndUserIntegrations
POST
Upload Inscribe
GET
Get Integration Links
POST
Upload Ocrolus
GET
Get PDFs
POST
Parse all PDF
POST
Upload PDF
POST
Upload Plaid assets
POST
Upload Plaid transactions
POST
Upload Yodlee
PUT
Update PDF attributes including status
PATCH
Send patch transactions for a pdf statement
POST
Reloads transactions for a pdf
POST
Unloads transactions for a pdf
POST
Update PDF currency
ISOApplication
POST
Upload an ISO application PDF for for an end user
GET
Get EndUser ISO Applications
POST
Upload an ISO application PDF for automated scrubbing in under 15 seconds
POST
Upload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
POST
Reprocess a single ISO application
GET
Get the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
GET
Get Missing Accounts (beta)
EnrichedTransactions
GET
Get end user transactions
GET
Get apitransactions
Transactions
POST
Create end user transactions (async)
GET
Get apitransactions
POST
Enrich transactions (sync)
DEL
Delete transactions
Policy
GET
Get the policy evaluations for an end user
POST
Progress policies for an end user
Testing
GET
Get apihello world
GET
Get apihello worldauthenticated
Merchants
POST
Post apimerchantsextract
GET
Get apimerchantsgroups
GET
Get apimerchantssearch
GET
Get apimerchants
PATCH
Patch apimerchants user merchant group
Rules
GET
Get rules
POST
Create a single rule
PUT
Update rule by heron_id
DEL
Delete rule by heron_id
ParsedEndUserSubmission
GET
Get parsed submissions for an End User
UserMerchantGroups
GET
This endpoint returns merchant groups categorized as pending, custom, or rejected.
Users
GET
Get user's company overview layout
PUT
Save user's company overview layout
PUT
Save user's settings
Webhooks
GET
Get webhooks
POST
Create a webhook
GET
Get webhook topics
PUT
Update a webhook
404
Page Not Found
We couldn't find the page you were looking for. Maybe you were looking for?
Release Notes
Update a data source account's account number
Update the end user file's class
Assistant
Responses are generated using AI and may contain mistakes.