API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEntity
EndUserFiles
- GETAll EndUserFiles
- GETGet all file classes
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser industry
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
Users
Refresh an IntegrationLink
Trigger a refresh operation for an IntegrationLink
curl --request POST \
--url https://app.herondata.io/api/integrations/{heron_id}/links/{link_item_id}/refresh \
--header 'Authorization: Basic <encoded-value>'
{
"link": {
"created": "2020-01-01T00:00:00Z",
"item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",
"last_successful_sync": "2020-01-01T00:00:00Z",
"last_updated": "2020-01-01T00:00:00Z",
"status": "active",
"status_message": "[ITEM_LOGIN_REQUIRED] the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. use Link's update mode to restore the item to a good state",
"type": "plaid_assets_report"
}
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
The Integration's heron_id
The IntegrationLink's item_id
Response
Unique identifier for each bank connection made by your end users. In Plaid this is the 'item_id'.
"M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"
When the integration link was created in Heron system
"2020-01-01T00:00:00Z"
When the integration link was last successfully synced
"2020-01-01T00:00:00Z"
When the integration link was last updated in Heron system
"2020-01-01T00:00:00Z"
The integration link status
pending
, active
, syncing
, erroring
, sync_disabled
, deleted_in_plaid
"active"
A message describing the 'erroring' status of the integration link
"[ITEM_LOGIN_REQUIRED] the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. use Link's update mode to restore the item to a good state"
The integration link type, inherited from the integration: plaid_assets_report or plaid_integration
"plaid_assets_report"
Was this page helpful?
curl --request POST \
--url https://app.herondata.io/api/integrations/{heron_id}/links/{link_item_id}/refresh \
--header 'Authorization: Basic <encoded-value>'
{
"link": {
"created": "2020-01-01T00:00:00Z",
"item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",
"last_successful_sync": "2020-01-01T00:00:00Z",
"last_updated": "2020-01-01T00:00:00Z",
"status": "active",
"status_message": "[ITEM_LOGIN_REQUIRED] the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. use Link's update mode to restore the item to a good state",
"type": "plaid_assets_report"
}
}