curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/ocrolus \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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": "07/08/2025"
}
],
"daily_balances": {},
"debt_consolidator_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"deposits_max_by_month": {},
"estimated_expense_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"factor_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"holder_country": "<string>",
"insurance_credits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"insurance_debits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"interbank_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"merchant_cash_advance_lender_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"non_estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"nsf_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"nsf_transactions_paid_or_negative_balance": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"nsf_transactions_returned_or_not_paid": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"outside_source_deposits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"payroll": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"period_balance_mismatches": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"ppp_loan_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"probable_recurring_txns": [
[
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
]
],
"returned_items": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"round_number_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"txn_count": 123,
"withdrawals": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"withdrawals_max_by_month": {}
}
],
"name": "<string>"
}
}'
{
"_summary": {
"request_id": "<string>"
}
}
Upload Ocrolus JSON for a specified end user to translate into Heron Data format and add transactions for the end user
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/ocrolus \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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": "07/08/2025"
}
],
"daily_balances": {},
"debt_consolidator_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"deposits_max_by_month": {},
"estimated_expense_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"factor_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"holder_country": "<string>",
"insurance_credits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"insurance_debits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"interbank_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"merchant_cash_advance_lender_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"non_estimated_revenue_txns_list": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"nsf_transactions": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"nsf_transactions_paid_or_negative_balance": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"nsf_transactions_returned_or_not_paid": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"outside_source_deposits": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"payroll": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"period_balance_mismatches": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"ppp_loan_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"probable_recurring_txns": [
[
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
]
],
"returned_items": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"round_number_txns": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"txn_count": 123,
"withdrawals": [
{
"amount": "<string>",
"description": "<string>",
"pk": 123,
"timestamp": "2023-11-07T05:31:56Z",
"txn_date": "07/08/2025"
}
],
"withdrawals_max_by_month": {}
}
],
"name": "<string>"
}
}'
{
"_summary": {
"request_id": "<string>"
}
}
The end_user_id
or heron_id
of EndUser to upload
Skip the check for the number of transactions in the payload
OK
The response is of type object
.
Was this page helpful?