Heron API

Heron's REST API for document intake, parsing, enrichment, cashflow underwriting, webhooks, and broker/funder submission flows.

Documentation Provider Profile APIs.io AsyncAPI GitHub

This event API exposes 11 operations across 11 channels, and defines 2 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

Requests are made against the base URL https://app.herondata.io/api.

11 operations 11 channels 2 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification

AsyncAPI 2.6.0

API Version

1.0.0

Base URL

https://app.herondata.io/api

Contact

Heron Data

Resource Areas

Channels & Operations 11

Across 11 channels, the API surfaces 11 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 11

SUB

end_user.processed

Triggered when asynchronous automated processing of an end user has finished (after the EndUser status is set to "ready").

onEndUserProcessed body

SUB

end_user.reviewed

Triggered when an underwriter / Heron has manually reviewed a company and set the EndUser status to "reviewed".

onEndUserReviewed body

SUB

end_user.review_required

Triggered when an end user violates a rule during processing and needs further review.

onEndUserReviewRequired body

SUB

end_user.transactions_updated

DEPRECATED — in the process of being deprecated; do not subscribe to this topic.

onEndUserTransactionsUpdated body

SUB

transactions.deleted

Triggered when transactions are deleted.

onTransactionsDeleted body

SUB

transactions.updated

Triggered within 10 minutes of the last change on transactions for a given end user (e.g. after category feedback or Heron manual review).

onTransactionsUpdated body

SUB

pdf.processed

Triggered when Heron has successfully processed a PDF document.

onPdfProcessed body

SUB

pdf.checks_passed

Triggered when the PDF reconciles and does not exceed the anomaly threshold (if fraud is enabled for your account).

onPdfChecksPassed body

SUB

pdf.checks_failed

Triggered when the PDF does not reconcile and/or exceeds the anomaly threshold (if fraud is enabled for your account).

onPdfChecksFailed body

SUB

pdf.failed

Triggered when Heron failed to process a PDF document (failed to extract any transactions).

onPdfFailed body

SUB

pdf.transactions_loaded

Triggered when the transactions from a processed PDF have been loaded into an enduserid.

onPdfTransactionsLoaded body

Messages & Schemas 2

The contract defines 2 schemas that model the data carried by its messages. The most detailed is WebhookEvent (4 properties). Each schema is shown below with its type and property counts.

HeronWebhookEvent

message

WebhookEvent

object

4 properties 3 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

#Document Automation#Underwriting#Financial Services

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Heron API

Metadata

Channels & Operations 11

Messages & Schemas 2

Specification

Source

API Details

Provider

Explore more