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 End User Integrations API

The EndUserIntegrations API from Heron — 15 operation(s) for enduserintegrations.

Heron End User Integrations API is one of 47 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 EndUserIntegrations. 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 16 operations across 15 paths, and defines 41 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.

16 operations 15 paths 41 schemas 3 GET1 PATCH11 POST1 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 End User 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 16

Across 15 paths, the API surfaces 16 operations — 3 GET, 1 PATCH, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

EndUserIntegrations 16
POST
/api/end_users/{end_user_id_or_heron_id}/decision_logic
Upload DecisionLogic XML
postApiEndUsersByEndUserIdOrHeronIdDecisionLogic 2 params body → 201
POST
/api/end_users/{end_user_id_or_heron_id}/inscribe
Upload Inscribe
postApiEndUsersByEndUserIdOrHeronIdInscribe 1 param body → 201
GET
/api/end_users/{end_user_id_or_heron_id}/integration_links
Get Integration Links
getApiEndUsersByEndUserIdOrHeronIdIntegrationLinks 1 param → 200
POST
/api/end_users/{end_user_id_or_heron_id}/ocrolus
Upload Ocrolus
postApiEndUsersByEndUserIdOrHeronIdOcrolus 2 params body → 201
GET
/api/end_users/{end_user_id_or_heron_id}/pdfs
Get PDFs
getApiEndUsersByEndUserIdOrHeronIdPdfs 2 params → 200
POST
/api/end_users/{end_user_id_or_heron_id}/pdfs/parse
Parse all PDF
postApiEndUsersByEndUserIdOrHeronIdPdfsParse 1 param → 200
POST
/api/end_users/{end_user_id_or_heron_id}/pdfs/v1
Upload PDF
postApiEndUsersByEndUserIdOrHeronIdPdfsV1 1 param body → 201
POST
/api/end_users/{end_user_id_or_heron_id}/plaid/assets
Upload Plaid assets
postApiEndUsersByEndUserIdOrHeronIdPlaidAssets 1 param body → 201
POST
/api/end_users/{end_user_id_or_heron_id}/plaid/transactions
Upload Plaid transactions
postApiEndUsersByEndUserIdOrHeronIdPlaidTransactions 1 param body → 201
POST
/api/end_users/{end_user_id_or_heron_id}/yodlee
Upload Yodlee
postApiEndUsersByEndUserIdOrHeronIdYodlee 1 param body → 201
GET
/api/integrations/pdfs/{heron_id}
Get single PDF by heronid
getApiIntegrationsPdfsByHeronId 2 params → 200404
PUT
/api/integrations/pdfs/{heron_id}
Update PDF attributes including status
putApiIntegrationsPdfsByHeronId 1 param body → 200
PATCH
/api/integrations/pdfs/{heron_id}/processed
Send patch transactions for a pdf statement
patchApiIntegrationsPdfsByHeronIdProcessed 1 param body → 200
POST
/api/integrations/pdfs/{heron_id}/reload_transactions
Reloads transactions for a pdf
postApiIntegrationsPdfsByHeronIdReloadTransactions 1 param → 200
POST
/api/integrations/pdfs/{heron_id}/unload_transactions
Unloads transactions for a pdf
postApiIntegrationsPdfsByHeronIdUnloadTransactions 1 param → 200
POST
/api/integrations/pdfs/{heron_id}/update_currency
Update PDF currency
postApiIntegrationsPdfsByHeronIdUpdateCurrency 1 param body → 200400404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are OcrolusBankAccount (28 properties), MoneyThumbStatementSummary (23 properties), PdfGetSchema (14 properties), PlaidTransaction (13 properties). Each schema is shown below with its type and property counts.

OcrolusSchema
object
1 property 1 required
YodleeAmount
object
2 properties
EndUser2
object
1 property
PdfPatchTransaction
object
9 properties
PlaidAccount
object
11 properties 4 required
OcrolusResponse
object
2 properties 2 required
PlaidTransaction
object
13 properties
YodleeTransaction
object
7 properties
PdfGetSchema
object
14 properties
InscribeParsedDetails
object
2 properties
PdfTransaction
object
9 properties 3 required
InscribeParsedDetailsName
object
1 property
PlaidAssetReportItem
object
2 properties 2 required
DataSourceNested
object
2 properties
PdfPostSchema
object
8 properties 1 required
MoneyThumbStatementSummary
object
23 properties 8 required
InscribeAccount
object
7 properties
PdfDefaultCurrencyUpdateSchema
object
1 property 1 required
PdfPutSchema
object
6 properties
InscribeTransaction
object
4 properties
PlaidAccountBalance
object
3 properties
PlaidAccountSnapshot
object
10 properties
IntegrationLinkSchema
object
11 properties 3 required
PlaidAccountSnapshotBalance
object
4 properties
InscribeNumberPrediction
object
3 properties
OcrolusBankAccount
object
28 properties
PdfStatement
object
5 properties
YodleeSchema
object
2 properties
DataSourceAccountNested
object
2 properties
OcrolusTransaction
object
5 properties
PdfStatementPatchSchema
object
4 properties 2 required
PlaidAccountOwners
object
1 property 1 required
PlaidAssetReport
object
3 properties 3 required
PlaidAssetsSchema
object
1 property 1 required
InscribeStringPrediction
object
3 properties
PlaidTransactionsSchema
object
2 properties 1 required
YodleeAccount
object
3 properties
YodleeTransactionDescription
object
2 properties
InscribeSchema
object
2 properties
MoneyThumbTransactionBounds
object
5 properties 5 required
PdfPatchStatementSummary
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-enduserintegrations-api-openapi.yml Raw ↑

Other APIs Heron publishes across the network.

Heron Analytics 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 End Users API
Heron End User Attributes API
Heron End User Calculations API
Heron End User Data Source Accounts API
Where this information came from

This is an independent, third-party profile of Heron End User 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.