Coming soon!

Legal - Case File Intake

Heron

Quickstart

Navigating This Documentation

MCA/ Cash Flow Underwriting

Insurance - Submission Intake

Insurance - Inspection Reports

Bank Statements Integration

Plaid Integration

Duplicate Transactions

Get Transaction Methods

Rate Limits and 429 Errors - Too Many Requests

Supported Currencies

Sync vs. Async

Webhook Delivery

Release Notes

Mechant Locking

Customer Spend Reporting

Authentication

Errors

Webhooks

Get categories

List CRM Integrations

Create a CRM integration, e.g., with Salesforce

Create a CRM integration

Patch a CRM integration

Update a data source account's account number


Update a data source account

Update a data source

Get a list of data sources accounts & their summarised information for a company


Get data source account summary

Get a list of data sources for a company


Get data sources

Get email templates

Create an email template used to send emails conditional on events like policy evaluation


Create an email template

Patch an email template

Get all emails for all end users associate with this user

Get EndUser emails

List EndUsers

Confirm an end user is ready for async processing by sending a status of "ready". The `end_user_id` must have previously been sent with at least one Transaction if attempting to update the status.


Update EndUser

Create a new end user. If transactions have previously been sent for this `end_user_id`, use `PUT end_users` to update instead.


Create EndUser

Get an end user using its end_user_id or heron_id


Get EndUser by heron_id or end_user_id

Delete an end user. You must delete associated transactions before doing this.


Delete EndUser by heron_id or end_user_id

Get the emails associated with an end user

Get the company details of an end user including loan information

Get EndUser information

Patch EndUser information

Enriches transactions of an end user identified by its end_user_id or heron_id. There is an optional `priority` parameter that can be set to `high` to prioritize the enrichment over `normal` (default) priority. High priority enrichment is only enabled for enterprise-level accounts. Please contact support@herondata.io to upgrade your account.


Enrich transactions of EndUser

Get the company physical address coordinates

Get EndUser physical location

Retrieve CRM sync events for an end user

Trigger a CRM Sync for an End User

Export an end user email as an EML file. Attachments are not included.

Export an end user email as an EML file

Get all files uploaded to Heron by your users, not including parsed results from files

All EndUserFiles

Get all file classes

Retrieve the most recent files for the specified file class.

Get recent files by file class

Retrieve all file rename rules for the current user.

Get file rename rules

Create a file rename rule

Update an existing rename rule identified by its `heron_id`.

Update a file rename rule

Use this endpoint to change the end user file's class. The file will be reprocessed as the new type.


Update the end user file's class

Get the base64 string representation of an end user file

Get EndUserFile as a base64 string

Trigger async parsing of an end user file

Update Parsed Results

Get parsed results from uploaded files

Trigger file's rename rule

Trigger splitting a combined end user file into its child files based on its page_classes

Get EndUserFiles

Upload file to an end user & asynchronously classify its type

Post EndUserFile

Download all files for an end user as a zip

Download EndUserFiles

Download xlsx of parsed results from uploaded files

Get balance for given EndUser on a daily and account granularity

Get EndUser balance

Get forecast amounts for a given EndUser and category

Get EndUser forecasts

Get summarized statistics for a given EndUser

Get EndUser statistics

Get anomalies for given EndUser given a category label or heron id

Get EndUser anomalies

Get the bank statement summary by month for an end user

Get EndUser bank statement summary

Get the benchmarks for each metric for an end user

Get EndUser metric benchmarks

Export a spreadsheet for an end user containing key metrics and reports


Export as a spreadsheet

Get a report of transactions grouped by merchant or counterparty for an end user

Get EndUser transactions grouped by counterparty or merchant

Get Heron Score for end user with a breakdown of the feature group contributions which resulted in the score. The score is calculated for the day of last transaction. This is a beta feature and is subject to change.

Get EndUser Heron Score (beta)

Predict the industry of the end user based on its name

Get EndUser industry

Get the summary of transactions by merchant for an end user for given categories or analytics groups

Get EndUser merchant summary

Get the named dates associated with an end user, e.g., date of last transaction

Get EndUser named dates

Calculates the cashflow profit & loss table for an end user, based on the layout defined (if any)


Get EndUser cashflow P&L

Update the profit and loss layout for the end user, which determines how the profit and loss table is calculated


Update EndUser P&L layout

Get a report of recurring transactions grouped by merchant or counterparty for an end user

Get EndUser recurring transactions report

Get scorecard metrics and rule violations for a user

Get EndUser scorecard

Request scorecard metrics for a date and end user

Request EndUser scorecard

Information about dates covered by any transaction data source

Get EndUser transaction data coverage

Get calculated attribute values for a given end user

Get EndUser attribute values

Provide bulk feedback on Transaction Categories for a specified end user

Bulk create category feedback for an end user

Provide feedback on a Transaction's Categories and Merchants

Create category, merchant feedback

Get the combined P&L & Balance Sheet data from financial documents for an EndUser

Get EndUser's combined financials

Evaluate all rules for an end user

Create a Finicity Link for an end user and send a Finicity Connect email to the end user to initiate the connection. The end user must have sufficient end user information to create the link.


Send a Finicity Connect email to an end user

Request a cashflow report generation for an end user. When the report is ready it will be available as EndUserFile.


Trigger a cashflow report generation for an end user

Request a Finicity statement reports generation for end user. Reports will be generated for each account available and each month going back in time between min_statement_index and max_statement_index. When the report is ready it will be available as EndUserFile.


Trigger a statement reports generation for an end user

Request a Finicity VOE transactions report generation for an end user. When the report is ready it will be available as an EndUserFile.


Trigger a Finicity VOE transactions report generation for an end user

Allows refreshing the access_token of an existing Integration Link

Update an Integration Link

List Integrations

Create an integration

Update Integration

Get a list of IntegrationLinks for an Integration filtered by end user

Get IntegrationLinks by Integration

Create a Link for an active Integration every time a customer connects their bank. In Plaid, this is a Plaid Link every time a customer connects their bank. For Plaid, call this after exchanging a public token for an Item access_token.


Create an integration Link

Soft-deletes of an integration link (sync is disabled)

(Soft-)Delete an integration link

Trigger a refresh operation for an IntegrationLink

Refresh an IntegrationLink

Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user


Upload Inscribe

Get a list of integration links for a specified end user


Get Integration Links

Upload Ocrolus JSON for a specified end user to translate into Heron Data format and add transactions for the end user


Upload Ocrolus

Get list of PDFs for a specified end user


Get PDFs

Starts parsing all PDFs for a specified end users. This will not restart any PDFs that are already being parsed


Parse all PDF

Upload encoded PDF of transactions for a specified end user to translate into Heron Data format


Upload PDF

Upload Plaid asset JSON for a specified end user to translate into Heron Data format and add transactions for the end user


Upload Plaid assets

Upload Plaid transactions JSON for a specified end user to translate into Heron Data format and add transactions for the end user


Upload Plaid transactions

Upload Yodlee JSON files for a specified end user to translate into Heron Data format and add transactions for the end user


Upload Yodlee

Update PDF attributes including status

Send patch transactions processed pdf that will override the extracted transactions in the specified statement


Send patch transactions for a pdf statement

This will load transactions for the pdf that is in a transactions unloaded status


Reloads transactions for a pdf

This will delete all transactions that were previously loaded for the pdf


Unloads transactions for a pdf

Use this endpoint to upload an ISO application PDF. Once uploaded, the file will be automatically scrubbed asynchronously. You can use the returned iso_application heron_id (prefixed "iso_") to fetch the scrubbing results. Please contact support@herondata.io to enable this endpoint.


Upload an ISO application PDF for for an end user

Get EndUser ISO Applications

Use this endpoint to upload an ISO application PDF. Once uploaded, the file will be automatically scrubbed asynchronously. You can use the returned heron_id (prefixed "iso_") to fetch the scrubbing results from the GET endpoint below. Please contact support@herondata.io to enable this endpoint.


Upload an ISO application PDF for automated scrubbing in under 15 seconds

This endpoint is for uploading ISO application PDFs in base64 format.


Upload an ISO application PDF for automated scrubbing in under 15 seconds (base64)

Use this endpoint to retrieve the scrubbed results and data validations of an uploaded ISO application PDF once it has finished processing. If processing is still underway, the processing_status field will be "processing".


Get the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")

Get a list of possible missing accounts for a given End User. This endpoint is in beta and likely to change.

Get Missing Accounts (beta)

Get all unique transactions for a single end user. Set end user status to "ready" to initiate transaction enrichment, otherwise may contain both enriched and unenriched transactions


Get end user transactions

Get apitransactions

Upload transactions for a specific end user. Does not include enriching transactions -- set end user status = 'ready' to initiate processing. For synchronous enrichment, please instead use "Enrich transactions (sync). Either timestamp (preferred) or date must be present in the transaction payload."


Create end user transactions (async)

Get transactions. At least `end_user_id`, `heron_id` or `request_id` must be provided.

Enrich and categorize transactions and consume them in a sync response. For business lending and underwriting, please use "Create end user transactions" instead. Please send a maximum of 249 transactions per request.


Enrich transactions (sync)

Please provide at least one of the following parameters: heron_ids, heron_id, request_id or end_user_id.


Delete transactions

Evaluates the user's policies against end user on-the-fly


Get Started

Use Cases

Integrations

FAQs

Miscellaneous

Legacy Use Cases

Legal - Case File Intake

Coming soon!

Get Started

Use Cases

Integrations

FAQs

Miscellaneous

Legacy Use Cases

​Coming soon!

Coming soon!