EndUserIntegrations
Upload Ocrolus
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
EndUserIntegrations
Upload Ocrolus
Upload Ocrolus JSON for a specified end user to translate into Heron Data format and add transactions for the end user
POST
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
ocrolus
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/ocrolus \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"response": {
"bank_accounts": [
{
"account_category": "<string>",
"account_number": "<string>",
"alternative_lender_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"daily_balances": {},
"debt_consolidator_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"deposits_max_by_month": {},
"estimated_expense_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"factor_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"holder_country": "<string>",
"insurance_credits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"insurance_debits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"interbank_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"merchant_cash_advance_lender_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"non_estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"nsf_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"nsf_transactions_paid_or_negative_balance": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"nsf_transactions_returned_or_not_paid": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"outside_source_deposits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"payroll": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"period_balance_mismatches": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"ppp_loan_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"probable_recurring_txns": [
[
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
]
],
"returned_items": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"round_number_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"txn_count": 123,
"withdrawals": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"withdrawals_max_by_month": {}
}
],
"name": "<string>"
}
}'
{
"_summary": {
"request_id": "<string>"
}
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
The end_user_id
or heron_id
of EndUser to upload
Query Parameters
Skip the check for the number of transactions in the payload
Body
application/json
Was this page helpful?
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/ocrolus \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"response": {
"bank_accounts": [
{
"account_category": "<string>",
"account_number": "<string>",
"alternative_lender_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"daily_balances": {},
"debt_consolidator_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"deposits_max_by_month": {},
"estimated_expense_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"factor_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"holder_country": "<string>",
"insurance_credits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"insurance_debits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"interbank_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"merchant_cash_advance_lender_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"non_estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"nsf_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"nsf_transactions_paid_or_negative_balance": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"nsf_transactions_returned_or_not_paid": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"outside_source_deposits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"payroll": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"period_balance_mismatches": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"ppp_loan_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"probable_recurring_txns": [
[
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
]
],
"returned_items": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"round_number_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"txn_count": 123,
"withdrawals": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25"
}
],
"withdrawals_max_by_month": {}
}
],
"name": "<string>"
}
}'
{
"_summary": {
"request_id": "<string>"
}
}