LEleantech
Assets

Get Cash Balances

The Cash Balances API provides a comprehensive view of both Personal or Business cash balances, offering insights into current, historical, and average balances. The data in this API allows financial companies to monitor liquidity trends and assess the financial health of bank accounts over time. Additionally, it provides information on the frequency and amount of contributions. You can use these insights to evaluate repayment capacity.

"Supported for both retail and corporate accounts"

get/insights/v2/assets/balances

Request

  • Base URL
    https://sandbox.leantech.me
  • URL
    https://sandbox.leantech.me/insights/v2/assets/balances
  • Auth
    HTTP bearer

Query parameters

entity_idstring uuid required

The entity_id you're querying for.

asyncboolean

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it''s recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

start_datestring date required

The start date in UTC (in the format YYYY-MM-DD) you want to query transactions for.

Response

OK

status'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED' required

The status of the request

results_idstring uuid required

The unique identifier for the request

messagestring required

A message describing the status of the request

metaobject nullable

Meta information about the request

timestampstring date-time required

The datetime of when the request was made

type'income' | 'employment' | 'cashflow' | 'credits-obligations' | 'non-credits-obligations' | 'expenses' | 'cash-balances' | 'freelancer-cashflow' | 'cashflow-patterns' | 'credit-assessments' | 'account-controls' | 'credit-obligations' | 'spending'

type of insight

Example response

{
  "insights": {
    "cashflow_patterns": [
      {
        "total_amount": {
          "currency": "AED"
        },
        "monthly_totals": [
          {
            "month": "2026-01",
            "amount": {
              "currency": "AED"
            }
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.