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

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

end_user_id_or_heron_id
string
required

The end_user_id or heron_id of EndUser to upload

Query Parameters

skip_num_txns_check
boolean

Skip the check for the number of transactions in the payload

Body

application/json
response
object
required

Response

201 - application/json
OK
_summary
object