How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heron Integrations API

The Integrations API from Heron — 9 operation(s) for integrations.

Heron Integrations API is one of 48 APIs that Heron publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Integration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 13 operations across 9 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 2021-07-19.

Requests are made against a single base URL, https://app.herondata.io.

13 operations 9 paths 8 schemas 1 DELETE2 GET7 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2021-07-19
Base URL
https://app.herondata.io/api
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Heron Integrations API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 2 GET, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Integrations 13
POST
/api/end_users/{end_user_id_or_heron_id}/finicity/connect
Send a Finicity Connect email to an end user
1 param → 200
POST
/api/end_users/{end_user_id_or_heron_id}/finicity/request_cashflow_report
Trigger a cashflow report generation for an end user
1 param body → 202
POST
/api/end_users/{end_user_id_or_heron_id}/finicity/request_statement_reports
Trigger a statement reports generation for an end user
1 param body → 202
POST
/api/end_users/{end_user_id_or_heron_id}/finicity/request_voe_transactions_report
Trigger a Finicity VOE transactions report generation for an end user
1 param body → 202
PUT
/api/integration_links/{item_id}
Update an Integration Link
1 param body → 200
GET
/api/integrations
List Integrations
→ 200
POST
/api/integrations
Create an integration
body → 201
PUT
/api/integrations/{heron_id}
Update Integration
1 param body → 200
DELETE
/api/integrations/{heron_id}/links
(Soft-)Delete an integration link
2 params → 204
GET
/api/integrations/{heron_id}/links
Get IntegrationLinks by Integration
2 params → 200
POST
/api/integrations/{heron_id}/links
Create an integration Link
1 param body → 201
PUT
/api/integrations/{heron_id}/links
Refresh assets reports for integration links
2 params → 200404422
POST
/api/integrations/{heron_id}/links/{link_item_id}/refresh
Refresh an IntegrationLink
2 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are IntegrationLinkNewSchema (12 properties), IntegrationLinkSchema (11 properties), IntegrationSchema (9 properties), FinicityRequestCashflowReportSchema (3 properties). Each schema is shown below with its type and property counts.

IntegrationSchema
object
9 properties 3 required
FinicityRequestStatementReportsSchema
object
2 properties
IntegrationLinkNewSchema
object
12 properties 3 required
IntegrationLinkSchema
object
11 properties 3 required
FinicityRequestVoeTransactionsReportSchema
object
1 property
FinicityRequestCashflowReportSchema
object
3 properties 3 required
RefreshAssetsReportsResponseSchema
object
2 properties 2 required
IntegrationLinkUpdateSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-integrations-api-openapi.yml Raw ↑

Other APIs Heron publishes across the network.

Heron Analytics API
Heron App Store API
Heron Authentication API
Heron Broker Funder Policies API
Heron Broker Submissions API
Heron Categories API
Heron Clear API
Heron Credentials API
Heron CRM Integrations API
Heron Email Templates API
Heron End Users API
Heron End User Accounts API
Where this information came from

This is an independent, third-party profile of Heron Integrations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.