API Reference
AppStore
API Reference
Categories
Credentials
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETList EndUsers with Summary Information
- GETGet duplicate end users for an end user
- 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
EndUserEnrichers
EndUserEntity
- GETGet the definitions for all end user entities
- POSTCreate an end user entity
- PATCHSet the display order of end user entities
- POSTCreate an end user entity attribute
- PATCHSet the display order of end user entity attributes
- DELDelete an EndUserEntityAttribute
- PATCHUpdate an end user entity
- POSTCreate an end user entity attribute
- POSTCreate an end user entity attribute source
- DELDelete an EndUserEntityAttribute
- PATCHUpsert an end user entity
- DELDelete an EndUserEntity
- PATCHUpdate an end user entity
- GETGet the materialised end user entities for an end user
- POSTUpsert the attribute value for an end user entity attribute source
EndUserFiles
- GETAll EndUserFiles
- POSTProcess file without creating EndUserFile record
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- GETGet file rename rule variable slugs
- PATCHUpdate a file rename rule
- DELDelete an EndUserFile
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- 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
- PATCHUpdate Parsed Results
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
FileClass
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETRun industry classification on end user files
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETGet EndUser debt candidates
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- 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
EndUserIntegrations
- POSTUpload DecisionLogic XML
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- GETGet single PDF by heron_id
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
- POSTUpdate PDF currency
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
- PUTRefresh assets reports for integration links
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
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)
- POSTReprocess a single ISO application
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
Rules
ParsedEndUserSubmission
UserMerchantGroups
Users
Webhooks
Create an integration
Copy
Ask AI
curl --request POST \
--url https://app.herondata.io/api/integrations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"integration": {
"name": "Plaid Prod",
"resource": "transaction",
"type": "<string>",
"base_url": "https://sandbox.plaid.com",
"client_auth": {},
"client_id": "<string>",
"client_secret": "<string>",
"webhook_url": "https://your-server.yourdomain.com/hooks"
}
}
'Copy
Ask AI
{
"integration": {
"name": "Plaid Prod",
"resource": "transaction",
"type": "<string>",
"base_url": "https://sandbox.plaid.com",
"client_id": "<string>",
"client_secret": "<string>",
"heron_id": "<string>",
"webhook_url": "https://your-server.yourdomain.com/hooks"
}
}Integrations
Create an integration
Create an integration e.g. with Plaid
POST
/
api
/
integrations
Create an integration
Copy
Ask AI
curl --request POST \
--url https://app.herondata.io/api/integrations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"integration": {
"name": "Plaid Prod",
"resource": "transaction",
"type": "<string>",
"base_url": "https://sandbox.plaid.com",
"client_auth": {},
"client_id": "<string>",
"client_secret": "<string>",
"webhook_url": "https://your-server.yourdomain.com/hooks"
}
}
'Copy
Ask AI
{
"integration": {
"name": "Plaid Prod",
"resource": "transaction",
"type": "<string>",
"base_url": "https://sandbox.plaid.com",
"client_id": "<string>",
"client_secret": "<string>",
"heron_id": "<string>",
"webhook_url": "https://your-server.yourdomain.com/hooks"
}
}Authorizations
Body
application/json
Show child attributes
Show child attributes
A name for your integration
Example:
"Plaid Prod"
For integrations with multiple available resources, the specific resource
Available options:
transaction, assets_report, end_user_application, invoice_factoring_processing, end_user_files, funder_decision The integration type, a specific provider
Base URL of the API integration. For Google Drive, use root_dir_path in client_auth instead.
Example:
"https://sandbox.plaid.com"
Client ID for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
Client Secret for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
URL provided by you to which we'll forward all webhooks (optional)
Example:
"https://your-server.yourdomain.com/hooks"
Response
201 - application/json
Created
Show child attributes
Show child attributes
A name for your integration
Example:
"Plaid Prod"
For integrations with multiple available resources, the specific resource
Available options:
transaction, assets_report, end_user_application, invoice_factoring_processing, end_user_files, funder_decision The integration type, a specific provider
Base URL of the API integration. For Google Drive, use root_dir_path in client_auth instead.
Example:
"https://sandbox.plaid.com"
Client ID for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
Client Secret for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
URL provided by you to which we'll forward all webhooks (optional)
Example:
"https://your-server.yourdomain.com/hooks"
Was this page helpful?
⌘I