# Heron

## Docs

- [Get decline analytics for a user](https://docs.herondata.io/api-reference/analytics/get-decline-analytics-for-a-user.md): Returns aggregated decline analytics for end users within a date range, including total end users, total declined, and per-check pass/fail/missing counts. Only the latest policy evaluation per end user is considered.
- [List available apps](https://docs.herondata.io/api-reference/appstore/list-available-apps.md): List available apps
- [Authentication](https://docs.herondata.io/api-reference/authentication.md)
- [Add details to broker submission](https://docs.herondata.io/api-reference/brokersubmissions/add-details-to-broker-submission.md): Add company and owner details to existing broker submission. **Authentication**: Requires a broker API key in the `x-api-key` header. Generate keys using the `/api/broker_submissions/api_keys/generate` endpoint.
- [Create broker submission](https://docs.herondata.io/api-reference/brokersubmissions/create-broker-submission.md): Create a new broker submission with end user details. **Authentication**: Requires a broker API key in the `x-api-key` header. Generate keys using the `/api/broker_submissions/api_keys/generate` endpoint.
- [Delete broker API key](https://docs.herondata.io/api-reference/brokersubmissions/delete-broker-api-key.md): Delete an existing API key for a broker-funder relationship. The authenticated user must own the funder account associated with the API key.
- [Generate broker API key](https://docs.herondata.io/api-reference/brokersubmissions/generate-broker-api-key.md): Create a new API key for a broker-funder relationship. The broker is identified by email domain. If the funder account or broker-funder relationship doesn't exist, they will be created automatically. Returns an error if an API key already exists for this relationship.
- [List broker API keys for a given user.](https://docs.herondata.io/api-reference/brokersubmissions/list-broker-api-keys-for-a-given-user.md): Retrieve all Broker API keys associated with the authenticated user's funder account. Returns a list of broker-funder relationships with their corresponding API keys.
- [Upload PDF files for broker submission](https://docs.herondata.io/api-reference/brokersubmissions/upload-pdf-files-for-broker-submission.md): Upload one or more PDF files for a specified broker submission. **Authentication**: Requires a broker API key in the `x-api-key` header. Generate keys using the `/api/broker_submissions/api_keys/generate` endpoint. **Response Status Codes:** - `201`: All files uploaded successfully - `207`: Partial…
- [Bulk update broker funder policies](https://docs.herondata.io/api-reference/bulk-update-broker-funder-policies.md): Create or update broker funder policies for the current user
- [Get categories](https://docs.herondata.io/api-reference/categories/get-categories.md): Get available categories
- [Activate an API key](https://docs.herondata.io/api-reference/credentials/activate-an-api-key.md): Re-activate a previously deactivated API key.
- [Create a new API key](https://docs.herondata.io/api-reference/credentials/create-a-new-api-key.md): Create a new named API key for the authenticated user. The full token is returned only in this response - it cannot be retrieved again.
- [Deactivate an API key](https://docs.herondata.io/api-reference/credentials/deactivate-an-api-key.md): Deactivate an API key. The key will stop working immediately but can be re-activated later. Use this instead of deleting to allow rollback.
- [Delete an API key](https://docs.herondata.io/api-reference/credentials/delete-an-api-key.md): Permanently delete an API key. This cannot be undone. Consider deactivating instead if you might need to rollback.
- [List API keys](https://docs.herondata.io/api-reference/credentials/list-api-keys.md): List all API keys for the authenticated user. Returns key metadata including name, token prefix, creation date, and active status. The `last_used` field is the most recent usage timestamp, or null if usage data is not available. Full tokens are never returned - only the first 8 characters where the…
- [Create a CRM integration](https://docs.herondata.io/api-reference/crmintegrations/create-a-crm-integration.md): Create a CRM integration, e.g., with Salesforce
- [List CRM Integrations](https://docs.herondata.io/api-reference/crmintegrations/list-crm-integrations.md): Get a list of CRM Integrations
- [Patch a CRM integration](https://docs.herondata.io/api-reference/crmintegrations/patch-a-crm-integration.md): patch a CRM integration
- [Create an email template](https://docs.herondata.io/api-reference/emailtemplates/create-an-email-template.md): Create an email template used to send emails conditional on events like policy evaluation
- [Get email templates](https://docs.herondata.io/api-reference/emailtemplates/get-email-templates.md): Read all available templates
- [Patch an email template](https://docs.herondata.io/api-reference/emailtemplates/patch-an-email-template.md): Update an email template
- [Get Missing Accounts (beta)](https://docs.herondata.io/api-reference/enduseraccounts/get-missing-accounts-beta.md): Get a list of possible missing accounts for a given End User. This endpoint is in beta and likely to change.
- [Get EndUser attribute values](https://docs.herondata.io/api-reference/enduserattributes/get-enduser-attribute-values.md): Get calculated attribute values for a given end user
- [Export as a spreadsheet](https://docs.herondata.io/api-reference/endusercalculations/export-as-a-spreadsheet.md): Export a spreadsheet for an end user containing key metrics and reports
- [Get EndUser anomalies](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-anomalies.md): Get anomalies for given EndUser given a category label or heron id
- [Get EndUser balance](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-balance.md): Get balance for given EndUser on a daily and account granularity
- [Get EndUser bank statement summary](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-bank-statement-summary.md): Get the bank statement summary by month for an end user
- [Get EndUser cashflow P&L](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-cashflow-p&l.md): Calculates the cashflow profit & loss table for an end user, based on the layout defined (if any)
- [Get EndUser debt candidates](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-debt-candidates.md): Identify potential debt candidates.
- [Get EndUser forecasts](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-forecasts.md): Get forecast amounts for a given EndUser and category
- [Get EndUser Heron Score (beta)](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-heron-score-beta.md): 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 merchant summary](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-merchant-summary.md): Get the summary of transactions by merchant for an end user for given categories or analytics groups
- [Get EndUser metric benchmarks](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-metric-benchmarks.md): Get the benchmarks for each metric for an end user
- [Get EndUser named dates](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-named-dates.md): Get the named dates associated with an end user, e.g., date of last transaction
- [Get EndUser recurring transactions report](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-recurring-transactions-report.md): Get a report of recurring transactions grouped by merchant or counterparty for an end user
- [Get EndUser scorecard](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-scorecard.md): Get scorecard metrics and rule violations for a user
- [Get EndUser statistics](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-statistics.md): Get summarized statistics for a given EndUser
- [Get EndUser transaction data coverage](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-transaction-data-coverage.md): Information about dates covered by any transaction data source
- [Get EndUser transactions grouped by counterparty or merchant](https://docs.herondata.io/api-reference/endusercalculations/get-enduser-transactions-grouped-by-counterparty-or-merchant.md): Get a report of transactions grouped by merchant or counterparty for an end user
- [Request EndUser scorecard](https://docs.herondata.io/api-reference/endusercalculations/request-enduser-scorecard.md): Request scorecard metrics for a date and end user
- [Update EndUser P&L layout](https://docs.herondata.io/api-reference/endusercalculations/update-enduser-p&l-layout.md): Update the profit and loss layout for the end user, which determines how the profit and loss table is calculated
- [Disable duplicate data source accounts for an end user](https://docs.herondata.io/api-reference/enduserdatasourceaccounts/disable-duplicate-data-source-accounts-for-an-end-user.md)
- [Update a data source account](https://docs.herondata.io/api-reference/enduserdatasourceaccounts/update-a-data-source-account.md): Update a data source account
- [Update a data source account's account number](https://docs.herondata.io/api-reference/enduserdatasourceaccounts/update-a-data-source-accounts-account-number.md): Update a data source account's account number
- [Get data source account summary](https://docs.herondata.io/api-reference/enduserdatasources/get-data-source-account-summary.md): Get a list of data sources accounts & their summarised information for a company
- [Get data sources](https://docs.herondata.io/api-reference/enduserdatasources/get-data-sources.md): Get a list of data sources for a company
- [Update a data source](https://docs.herondata.io/api-reference/enduserdatasources/update-a-data-source.md): Update a data source
- [Export an end user email as an EML file](https://docs.herondata.io/api-reference/enduseremails/export-an-end-user-email-as-an-eml-file.md): Export an end user email as an EML file. Attachments are not included.
- [Get all fields for all enrichers for a given user](https://docs.herondata.io/api-reference/enduserenrichers/get-all-fields-for-all-enrichers-for-a-given-user.md)
- [Get enricher result by enricher name and end user](https://docs.herondata.io/api-reference/enduserenrichers/get-enricher-result-by-enricher-name-and-end-user.md): Retrieve the latest result for a specific enricher and end user
- [Get enrichment results for an end user](https://docs.herondata.io/api-reference/enduserenrichers/get-enrichment-results-for-an-end-user.md): Get all latest enrichment results for a given end user by their Heron ID.
- [Start enricher execution for a specific end user asynchronously](https://docs.herondata.io/api-reference/enduserenrichers/start-enricher-execution-for-a-specific-end-user-asynchronously.md): Dispatches an enricher task for an end user and returns immediately.
- [Trigger enricher execution for a specific end user](https://docs.herondata.io/api-reference/enduserenrichers/trigger-enricher-execution-for-a-specific-end-user.md): Executes a specified enricher for an end user and returns the enrichment result. The enrichment result is automatically saved to the database.
- [Bulk save entity attribute values by entity name and attribute name](https://docs.herondata.io/api-reference/enduserentity/bulk-save-entity-attribute-values-by-entity-name-and-attribute-name.md): Save multiple entity attribute values in a single request. Each item specifies the entity name, attribute name, and value to set. If an API source doesn't exist for an attribute, one will be created.
- [Create an end user entity](https://docs.herondata.io/api-reference/enduserentity/create-an-end-user-entity.md)
- [Create an end user entity attribute](https://docs.herondata.io/api-reference/enduserentity/create-an-end-user-entity-attribute.md)
- [Create an end user entity attribute](https://docs.herondata.io/api-reference/enduserentity/create-an-end-user-entity-attribute-1.md)
- [Create an end user entity attribute source](https://docs.herondata.io/api-reference/enduserentity/create-an-end-user-entity-attribute-source.md)
- [Delete an EndUserEntity](https://docs.herondata.io/api-reference/enduserentity/delete-an-enduserentity.md)
- [Delete an EndUserEntityAttribute](https://docs.herondata.io/api-reference/enduserentity/delete-an-enduserentityattribute.md)
- [Delete an EndUserEntityAttribute](https://docs.herondata.io/api-reference/enduserentity/delete-an-enduserentityattribute-1.md)
- [Export all saved attribute for all end users to an Excel file](https://docs.herondata.io/api-reference/enduserentity/export-all-saved-attribute-for-all-end-users-to-an-excel-file.md): Export a spreadsheet with saved entity attribute values (API sources only) for all end users under the current user.
- [Get the definitions for all end user entities](https://docs.herondata.io/api-reference/enduserentity/get-the-definitions-for-all-end-user-entities.md)
- [Get the materialised end user entities for an end user](https://docs.herondata.io/api-reference/enduserentity/get-the-materialised-end-user-entities-for-an-end-user.md)
- [Set the display order of end user entities](https://docs.herondata.io/api-reference/enduserentity/set-the-display-order-of-end-user-entities.md)
- [Set the display order of end user entity attributes](https://docs.herondata.io/api-reference/enduserentity/set-the-display-order-of-end-user-entity-attributes.md)
- [Update an end user entity](https://docs.herondata.io/api-reference/enduserentity/update-an-end-user-entity.md)
- [Update an end user entity](https://docs.herondata.io/api-reference/enduserentity/update-an-end-user-entity-1.md)
- [Upsert an end user entity](https://docs.herondata.io/api-reference/enduserentity/upsert-an-end-user-entity.md)
- [Upsert the attribute value for an end user entity attribute source](https://docs.herondata.io/api-reference/enduserentity/upsert-the-attribute-value-for-an-end-user-entity-attribute-source.md)
- [All EndUserFiles](https://docs.herondata.io/api-reference/enduserfiles/all-enduserfiles.md): Get all files uploaded to Heron by your users, not including parsed results from files
- [Create a file rename rule](https://docs.herondata.io/api-reference/enduserfiles/create-a-file-rename-rule.md): Add a new rename rule for files.
- [Delete an EndUserFile](https://docs.herondata.io/api-reference/enduserfiles/delete-an-enduserfile.md)
- [Download EndUserFiles](https://docs.herondata.io/api-reference/enduserfiles/download-enduserfiles.md): Download all files for an end user as a zip
- [Download xlsx of parsed results from uploaded files](https://docs.herondata.io/api-reference/enduserfiles/download-xlsx-of-parsed-results-from-uploaded-files.md)
- [Get a single end user file by Heron ID](https://docs.herondata.io/api-reference/enduserfiles/get-a-single-end-user-file-by-heron-id.md): Retrieve a single end user file by its Heron ID. Returns file metadata including filename, file class, parsed results (if any), and related info. Use this endpoint when you have an end user file Heron ID and need its details without listing or filtering all files.
- [Get EndUserFile as a base64 string](https://docs.herondata.io/api-reference/enduserfiles/get-enduserfile-as-a-base64-string.md): Get the base64 string representation of an end user file
- [Get EndUserFiles](https://docs.herondata.io/api-reference/enduserfiles/get-enduserfiles.md): Get all files for an end user
- [Get file rename rule variable slugs](https://docs.herondata.io/api-reference/enduserfiles/get-file-rename-rule-variable-slugs.md): Retrieve all file rename rules slugs for the current user.
- [Get file rename rules](https://docs.herondata.io/api-reference/enduserfiles/get-file-rename-rules.md): Retrieve all file rename rules for the current user.
- [Get parsed results from uploaded files](https://docs.herondata.io/api-reference/enduserfiles/get-parsed-results-from-uploaded-files.md)
- [Get recent files by file class](https://docs.herondata.io/api-reference/enduserfiles/get-recent-files-by-file-class.md): Retrieve the most recent files for the specified file class.
- [Post EndUserFile](https://docs.herondata.io/api-reference/enduserfiles/post-enduserfile.md): Deprecated — use [Post EndUserFile V2](/api-reference/enduserfiles/post-enduserfile-v2) instead.
- [Post EndUserFile V2](https://docs.herondata.io/api-reference/enduserfiles/post-enduserfile-v2.md): Upload file to an end user & asynchronously classify its type. After uploading, call the `/start_workflow` endpoint to trigger downstream processing (parsing, bank statement extraction, etc.).
- [Process file without creating EndUserFile record](https://docs.herondata.io/api-reference/enduserfiles/process-file-without-creating-enduserfile-record.md): Process a file for classification and parsing without storing it as an EndUserFile. Results are delivered via webhook to subscribed endpoints.
- [Start Workflow](https://docs.herondata.io/api-reference/enduserfiles/start-workflow.md): Starts your configured Heron workflow for an end user
- [Trigger async parsing of an end user file](https://docs.herondata.io/api-reference/enduserfiles/trigger-async-parsing-of-an-end-user-file.md)
- [Trigger file's rename rule](https://docs.herondata.io/api-reference/enduserfiles/trigger-files-rename-rule.md)
- [Trigger splitting a combined end user file into its child files based on its page_classes](https://docs.herondata.io/api-reference/enduserfiles/trigger-splitting-a-combined-end-user-file-into-its-child-files-based-on-its-page_classes.md)
- [Update a file rename rule](https://docs.herondata.io/api-reference/enduserfiles/update-a-file-rename-rule.md): Update an existing rename rule identified by its `heron_id`.
- [Update Parsed Results](https://docs.herondata.io/api-reference/enduserfiles/update-parsed-results.md)
- [Update the end user file's class](https://docs.herondata.io/api-reference/enduserfiles/update-the-end-user-files-class.md): Use this endpoint to change the end user file's class. The file will be reprocessed as the new type.
- [Get EndUser's combined financials](https://docs.herondata.io/api-reference/enduserfinancials/get-endusers-combined-financials.md): Get the combined P&L & Balance Sheet data from financial documents for an EndUser
- [Get Integration Links](https://docs.herondata.io/api-reference/enduserintegrations/get-integration-links.md): Get a list of integration links for a specified end user
- [Get PDFs](https://docs.herondata.io/api-reference/enduserintegrations/get-pdfs.md): Get list of PDFs for a specified end user
- [Get single PDF by heron_id](https://docs.herondata.io/api-reference/enduserintegrations/get-single-pdf-by-heron_id.md): Retrieve a single PDF document by its heron_id. Returns the PDF metadata, status information, and optionally the processed statements/transactions. Users can only access their own PDFs.
- [Parse all PDF](https://docs.herondata.io/api-reference/enduserintegrations/parse-all-pdf.md): Starts parsing all PDFs for a specified end users. This will not restart any PDFs that are already being parsed
- [Reloads transactions for a pdf](https://docs.herondata.io/api-reference/enduserintegrations/reloads-transactions-for-a-pdf.md): This will load transactions for the pdf that is in a transactions unloaded status
- [Send patch transactions for a pdf statement](https://docs.herondata.io/api-reference/enduserintegrations/send-patch-transactions-for-a-pdf-statement.md): Send patch transactions processed pdf that will override the extracted transactions in the specified statement
- [Unloads transactions for a pdf](https://docs.herondata.io/api-reference/enduserintegrations/unloads-transactions-for-a-pdf.md): This will delete all transactions that were previously loaded for the pdf
- [Update PDF attributes including status](https://docs.herondata.io/api-reference/enduserintegrations/update-pdf-attributes-including-status.md): Update PDF attributes including status
- [Update PDF currency](https://docs.herondata.io/api-reference/enduserintegrations/update-pdf-currency.md): Update the currency for a PDF and all its statement summaries. The PDF must be in transactions_unloaded status.
- [Upload DecisionLogic XML](https://docs.herondata.io/api-reference/enduserintegrations/upload-decisionlogic-xml.md): Upload DecisionLogic XML files for a specified end user to translate into Heron Data format and add transactions for the end user
- [Upload Inscribe](https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe.md): Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user
- [Upload Ocrolus](https://docs.herondata.io/api-reference/enduserintegrations/upload-ocrolus.md): Upload Ocrolus JSON for a specified end user to translate into Heron Data format and add transactions for the end user
- [Upload PDF](https://docs.herondata.io/api-reference/enduserintegrations/upload-pdf.md): Upload encoded PDF of transactions for a specified end user to translate into Heron Data format
- [Upload Plaid assets](https://docs.herondata.io/api-reference/enduserintegrations/upload-plaid-assets.md): Upload Plaid asset JSON for a specified end user to translate into Heron Data format and add transactions for the end user
- [Upload Plaid transactions](https://docs.herondata.io/api-reference/enduserintegrations/upload-plaid-transactions.md): Upload Plaid transactions JSON for a specified end user to translate into Heron Data format and add transactions for the end user
- [Upload Yodlee](https://docs.herondata.io/api-reference/enduserintegrations/upload-yodlee.md): Upload Yodlee JSON files for a specified end user to translate into Heron Data format and add transactions for the end user
- [Evaluate all rules for an end user](https://docs.herondata.io/api-reference/enduserrules/evaluate-all-rules-for-an-end-user.md)
- [Create EndUser](https://docs.herondata.io/api-reference/endusers/create-enduser.md): Create a new end user. If transactions have previously been sent for this `end_user_id`, use `PUT end_users` to update instead.
- [Delete EndUser by heron_id or end_user_id (async)](https://docs.herondata.io/api-reference/endusers/delete-enduser-by-heron_id-or-end_user_id-async.md): Asynchronously delete an end user and its associated transactions. Returns immediately with a 202 status while deletion proceeds in the background.
- [Delete EndUser by heron_id or end_user_id (sync)](https://docs.herondata.io/api-reference/endusers/delete-enduser-by-heron_id-or-end_user_id-sync.md): Synchronously delete an end user and its associated transactions. Deprecated — use POST /end_users/{end_user_id_or_heron_id}/delete for async deletion instead.
- [Enrich transactions of EndUser](https://docs.herondata.io/api-reference/endusers/enrich-transactions-of-enduser.md): 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 su…
- [Get duplicate end users for an end user](https://docs.herondata.io/api-reference/endusers/get-duplicate-end-users-for-an-end-user.md): Find duplicate end users for the given end user by matching on EIN (federal_tax_id) or normalized legal business name. Only returns duplicates within the same user (lender). Matching strategy: (1) Priority - Match by EIN when available (fast indexed query), (2) Fallback - Match by normalized company…
- [Get EndUser by heron_id or end_user_id](https://docs.herondata.io/api-reference/endusers/get-enduser-by-heron_id-or-end_user_id.md): Get an end user using its end_user_id or heron_id
- [Get EndUser emails](https://docs.herondata.io/api-reference/endusers/get-enduser-emails.md): Get all emails for all end users associate with this user
- [Get EndUser emails](https://docs.herondata.io/api-reference/endusers/get-enduser-emails-1.md): Get the emails associated with an end user
- [Get EndUser information](https://docs.herondata.io/api-reference/endusers/get-enduser-information.md): Get the company details of an end user including loan information
- [Get EndUser physical location](https://docs.herondata.io/api-reference/endusers/get-enduser-physical-location.md): Get the company physical address coordinates
- [Get EndUser processing status](https://docs.herondata.io/api-reference/endusers/get-enduser-processing-status.md): Get the current processing status of an end user by heron_id or end_user_id. Returns whether the end user is currently being processed or has completed processing.
- [List EndUsers](https://docs.herondata.io/api-reference/endusers/list-endusers.md): Get a list of EndUsers
- [List EndUsers with Summary Information](https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information.md): Get a list of EndUsers
- [Patch EndUser information](https://docs.herondata.io/api-reference/endusers/patch-enduser-information.md): Update the end user information
- [Retrieve CRM sync events for an end user](https://docs.herondata.io/api-reference/endusers/retrieve-crm-sync-events-for-an-end-user.md)
- [Trigger a CRM Sync for an End User](https://docs.herondata.io/api-reference/endusers/trigger-a-crm-sync-for-an-end-user.md)
- [Update EndUser](https://docs.herondata.io/api-reference/endusers/update-enduser.md): 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.
- [Get apitransactions](https://docs.herondata.io/api-reference/enrichedtransactions/get-apitransactions.md): Get enriched transaction
- [Get end user transactions](https://docs.herondata.io/api-reference/enrichedtransactions/get-end-user-transactions.md): 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
- [Bulk create category feedback for an end user](https://docs.herondata.io/api-reference/enrichmentfeedback/bulk-create-category-feedback-for-an-end-user.md): Provide bulk feedback on Transaction Categories for a specified end user
- [Create category, merchant feedback](https://docs.herondata.io/api-reference/enrichmentfeedback/create-category-merchant-feedback.md): Provide feedback on a Transaction's Categories and Merchants
- [Errors](https://docs.herondata.io/api-reference/errors.md)
- [Export broker funder policies as Excel](https://docs.herondata.io/api-reference/export-broker-funder-policies-as-excel.md): Download the current user's broker funder policies as an Excel spreadsheet. The exported file can be re-uploaded via POST /broker_funder_policies/upload/ to round-trip policies.
- [Add a FileClass to Classify for a User](https://docs.herondata.io/api-reference/fileclass/add-a-fileclass-to-classify-for-a-user.md)
- [Get all file classes](https://docs.herondata.io/api-reference/fileclass/get-all-file-classes.md)
- [Get current file classes used in classification](https://docs.herondata.io/api-reference/fileclass/get-current-file-classes-used-in-classification.md)
- [Remove a FileClass from Classification for a User](https://docs.herondata.io/api-reference/fileclass/remove-a-fileclass-from-classification-for-a-user.md)
- [Get a single funder](https://docs.herondata.io/api-reference/funders/get-a-single-funder.md): Get details of a specific funder by heron_id
- [List all funders](https://docs.herondata.io/api-reference/funders/list-all-funders.md): Get a list of all available funders
- [List your linked funders](https://docs.herondata.io/api-reference/funders/list-your-linked-funders.md): Get a list of funders linked to the current user
- [Get funder submission status](https://docs.herondata.io/api-reference/get-funder-submission-status.md): Returns the status and details of a funder submission. Use this to poll after triggering a submission.
- [Get policy upload job status](https://docs.herondata.io/api-reference/get-policy-upload-job-status.md): Get the status of the most recent policy upload job for the current user
- [Get specific policy upload job](https://docs.herondata.io/api-reference/get-specific-policy-upload-job.md): Get a specific policy upload job by its Heron ID
- [Create an integration](https://docs.herondata.io/api-reference/integrations/create-an-integration.md): Create an integration e.g. with Plaid
- [Create an integration Link](https://docs.herondata.io/api-reference/integrations/create-an-integration-link.md): 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.
- [Get IntegrationLinks by Integration](https://docs.herondata.io/api-reference/integrations/get-integrationlinks-by-integration.md): Get a list of IntegrationLinks for an Integration filtered by end user
- [List Integrations](https://docs.herondata.io/api-reference/integrations/list-integrations.md): Get a list of Integrations
- [Refresh an IntegrationLink](https://docs.herondata.io/api-reference/integrations/refresh-an-integrationlink.md): Trigger a refresh operation for an IntegrationLink
- [Refresh assets reports for integration links](https://docs.herondata.io/api-reference/integrations/refresh-assets-reports-for-integration-links.md): Refresh assets reports for an integration and specific end user. This will trigger a refresh operation for all active Plaid assets report links associated with the integration and end user.
- [Send a Finicity Connect email to an end user](https://docs.herondata.io/api-reference/integrations/send-a-finicity-connect-email-to-an-end-user.md): 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.
- [(Soft-)Delete an integration link](https://docs.herondata.io/api-reference/integrations/soft-delete-an-integration-link.md): Soft-deletes of an integration link (sync is disabled)
- [Trigger a cashflow report generation for an end user](https://docs.herondata.io/api-reference/integrations/trigger-a-cashflow-report-generation-for-an-end-user.md): Request a cashflow report generation for an end user. When the report is ready it will be available as EndUserFile.
- [Trigger a Finicity VOE transactions report generation for an end user](https://docs.herondata.io/api-reference/integrations/trigger-a-finicity-voe-transactions-report-generation-for-an-end-user.md): 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 statement reports generation for an end user](https://docs.herondata.io/api-reference/integrations/trigger-a-statement-reports-generation-for-an-end-user.md): 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.
- [Update an Integration Link](https://docs.herondata.io/api-reference/integrations/update-an-integration-link.md): Allows refreshing the access_token of an existing Integration Link
- [Update Integration](https://docs.herondata.io/api-reference/integrations/update-integration.md): Update an Integration
- [Get EndUser ISO Applications](https://docs.herondata.io/api-reference/isoapplication/get-enduser-iso-applications.md): Get all ISO applications for an end user
- [Get the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")](https://docs.herondata.io/api-reference/isoapplication/get-the-scrubbed-results-and-data-validations-of-an-uploaded-iso-application-by-its-heron_id-prefixed-"iso_".md): 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".
- [Reprocess a single ISO application](https://docs.herondata.io/api-reference/isoapplication/reprocess-a-single-iso-application.md): Use this endpoint to trigger reprocessing of a specific ISO application. This will re-run the parsing and validation process for the specified application.
- [Upload an ISO application PDF for automated scrubbing in under 15 seconds](https://docs.herondata.io/api-reference/isoapplication/upload-an-iso-application-pdf-for-automated-scrubbing-in-under-15-seconds.md): 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 (base64)](https://docs.herondata.io/api-reference/isoapplication/upload-an-iso-application-pdf-for-automated-scrubbing-in-under-15-seconds-base64.md): This endpoint is for uploading ISO application PDFs in base64 format.
- [Upload an ISO application PDF for for an end user](https://docs.herondata.io/api-reference/isoapplication/upload-an-iso-application-pdf-for-for-an-end-user.md): 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.
- [List broker funder policies for current user](https://docs.herondata.io/api-reference/list-broker-funder-policies-for-current-user.md): Get all broker funder policies for the current user, ordered by matching priority
- [List funder policy evaluations for an end user](https://docs.herondata.io/api-reference/list-funder-policy-evaluations-for-an-end-user.md): Get all funder policy evaluations for a specific end user
- [List pending funder matches for a job](https://docs.herondata.io/api-reference/list-pending-funder-matches-for-a-job.md): Get all pending funder matches that need manual resolution for a specific upload job
- [Get apimerchants](https://docs.herondata.io/api-reference/merchants/get-apimerchants.md): Get Merchant by heron_id
- [Get apimerchantsgroups](https://docs.herondata.io/api-reference/merchants/get-apimerchantsgroups.md): Get Merchant groups
- [Get apimerchantssearch](https://docs.herondata.io/api-reference/merchants/get-apimerchantssearch.md): Search Merchants by name
- [Patch apimerchants user merchant group](https://docs.herondata.io/api-reference/merchants/patch-apimerchants-user_merchant_group.md): Update the group id for a merchant for the current user
- [Post apimerchantsextract](https://docs.herondata.io/api-reference/merchants/post-apimerchantsextract.md): Extract Merchant from a transaction description
- [Get parsed submissions for an End User](https://docs.herondata.io/api-reference/parsedendusersubmission/get-parsed-submissions-for-an-end-user.md)
- [Get the policy evaluations for an end user](https://docs.herondata.io/api-reference/policy/get-the-policy-evaluations-for-an-end-user.md): Evaluates the user's policies against end user on-the-fly
- [Progress policies for an end user](https://docs.herondata.io/api-reference/policy/progress-policies-for-an-end-user.md): Triggers the policy progression workflow for a specific end user
- [Get positions summary for end user](https://docs.herondata.io/api-reference/positions/get-positions-summary-for-end-user.md): Returns positions with calculated metrics for an end user, optionally filtered by account IDs
- [Get transactions for a specific position](https://docs.herondata.io/api-reference/positions/get-transactions-for-a-specific-position.md): Returns investment and repayment transactions for a specific position
- [Resolve a pending funder match](https://docs.herondata.io/api-reference/resolve-a-pending-funder-match.md): Resolve a pending match by selecting a funder. This will create the broker_funder record with the policy data and mark the pending match as resolved.
- [Create a single rule](https://docs.herondata.io/api-reference/rules/create-a-single-rule.md): Create a new rule to send a 'end_user.review_required' webhook after processing if rule condition evaluates to true
- [Delete rule by heron_id](https://docs.herondata.io/api-reference/rules/delete-rule-by-heron_id.md): Delete a rule
- [Get metrics](https://docs.herondata.io/api-reference/rules/get-metrics.md): Read all available metrics to define rules on
- [Get rules](https://docs.herondata.io/api-reference/rules/get-rules.md): Read all available rules
- [Update rule by heron_id](https://docs.herondata.io/api-reference/rules/update-rule-by-heron_id.md): Update a rule
- [Skip a pending funder match](https://docs.herondata.io/api-reference/skip-a-pending-funder-match.md): Skip a pending match without resolving it. This will mark it as skipped.
- [Submit an end user to a single funder](https://docs.herondata.io/api-reference/submit-an-end-user-to-a-single-funder.md): Triggers an async submission for a specific funder submission. Returns 202 immediately; poll the submission status to check progress.
- [Get apihello world](https://docs.herondata.io/api-reference/testing/get-apihello_world.md): Test endpoint (no authentication)
- [Get apihello worldauthenticated](https://docs.herondata.io/api-reference/testing/get-apihello_worldauthenticated.md): Test authentication
- [Create end user transactions (async)](https://docs.herondata.io/api-reference/transactions/create-end-user-transactions-async.md): 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."
- [Delete transactions](https://docs.herondata.io/api-reference/transactions/delete-transactions.md): Please provide at least one of the following parameters: heron_ids, heron_id, request_id or end_user_id.
- [Enrich transactions (sync)](https://docs.herondata.io/api-reference/transactions/enrich-transactions-sync.md): 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.
- [Get apitransactions](https://docs.herondata.io/api-reference/transactions/get-apitransactions.md): Get transactions. At least `end_user_id`, `heron_id` or `request_id` must be provided.
- [Trigger a funder submission](https://docs.herondata.io/api-reference/trigger-a-funder-submission.md): Triggers an async submission to a funder. Returns 202 immediately; poll via GET /funder_submissions/{submission_heron_id}/ to check progress.
- [Upload funder policy file for parsing](https://docs.herondata.io/api-reference/upload-funder-policy-file-for-parsing.md): Upload a spreadsheet (XLS, XLSX, CSV) or PDF containing funder policies. The file will be parsed asynchronously and policies will be upserted for the current user. Only one upload job can be active at a time per user.
- [Upsert a funder submission](https://docs.herondata.io/api-reference/upsert-a-funder-submission.md): Find or create a funder submission for the given end user and funder pair. Returns the existing submission if one already exists (unique per end_user + funder).
- [This endpoint returns merchant groups categorized as pending, custom, or rejected.](https://docs.herondata.io/api-reference/usermerchantgroups/this-endpoint-returns-merchant-groups-categorized-as-pending-custom-or-rejected.md)
- [Get user's company overview layout](https://docs.herondata.io/api-reference/users/get-users-company-overview-layout.md)
- [Save user's company overview layout](https://docs.herondata.io/api-reference/users/save-users-company-overview-layout.md)
- [Save user's settings](https://docs.herondata.io/api-reference/users/save-users-settings.md)
- [Retrieve user logo](https://docs.herondata.io/api-reference/watermarks/retrieve-user-logo.md): Retrieve the logo file for the current user as raw bytes.
- [Upload user logo](https://docs.herondata.io/api-reference/watermarks/upload-user-logo.md): Upload a logo file for the current user. The file is validated for security and stored in GCS.
- [Webhooks](https://docs.herondata.io/api-reference/webhooks.md)
- [Create a webhook](https://docs.herondata.io/api-reference/webhooks/create-a-webhook.md): Create a webhook
- [Delete a webhook](https://docs.herondata.io/api-reference/webhooks/delete-a-webhook.md): Delete a webhook by its heron_id. The webhook must belong to the authenticated user.
- [Get webhook topics](https://docs.herondata.io/api-reference/webhooks/get-webhook-topics.md): Get webhook topics
- [Get webhooks](https://docs.herondata.io/api-reference/webhooks/get-webhooks.md): Get webhook
- [Update a webhook](https://docs.herondata.io/api-reference/webhooks/update-a-webhook.md): Update a webhook
- [List workflows for the current user](https://docs.herondata.io/api-reference/workflows/list-workflows-for-the-current-user.md): Returns all workflows belonging to the authenticated user.
- [Start a workflow by name for an end user](https://docs.herondata.io/api-reference/workflows/start-a-workflow-by-name-for-an-end-user.md): Start a workflow by name for an end user
- [Duplicate Transactions](https://docs.herondata.io/faqs/duplicate-transactions.md)
- [Get Transaction Methods](https://docs.herondata.io/faqs/get-transactions.md)
- [OpenAPI JSON (Swagger) ](https://docs.herondata.io/faqs/open-api-json.md)
- [Rate Limits and 429 Errors - Too Many Requests](https://docs.herondata.io/faqs/rate-limits-429-errors.md)
- [Supported Currencies](https://docs.herondata.io/faqs/supported-currencies.md)
- [Supported File Formats](https://docs.herondata.io/faqs/supported-file-formats.md)
- [Sync vs. Async](https://docs.herondata.io/faqs/sync-vs-async.md)
- [Webhook Delivery](https://docs.herondata.io/faqs/webhooks.md)
- [Navigating This Documentation](https://docs.herondata.io/get-started/introduction.md)
- [Quickstart](https://docs.herondata.io/get-started/quickstart.md)
- [Bank Statements Integration](https://docs.herondata.io/integrations/bank-statements.md)
- [Managing Broker API Keys](https://docs.herondata.io/integrations/broker-api-keys.md): Handle your own brokers' integrations with Heron via our Broker API key management endpoints
- [Broker Submissions API](https://docs.herondata.io/integrations/broker-submissions.md): Send complete funding submissions directly to funders using our Broker Submissions API
- [Plaid Integration](https://docs.herondata.io/integrations/plaid.md)
- [Release Notes](https://docs.herondata.io/miscellaneous/release-notes.md)
- [Merchant Locking](https://docs.herondata.io/use-cases/merchant-locking.md)
- [Customer Spend Reporting](https://docs.herondata.io/use-cases/smb-analytics.md)
- [MCA/Cash Flow Underwriting](https://docs.herondata.io/use-cases/smb-underwriting.md)

## OpenAPI Specs

- [swagger](https://app.herondata.io/swagger)
- [openapi-from-anchor-url-0](https://docs.herondata.io/openapi-from-anchor-url-0)
- [openapi](https://docs.herondata.io/api-reference/openapi.json)

## Optional

- [Heron](https://herondata.io)
- [Dashboard](https://dashboard.herondata.io)