Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Credit Obligations (New)

Get Credit Obligations

Delivers a structured view of a user's borrowing activity as per the connected account. Shows repayments and disbursements broken down by lender name and credit type.

get/insights/v3/credit-obligations

Query parameters

entity_idstring uuid required

The entity_id you're querying for.

start_datestring date

The start date in UTC (in the format YYYY-MM-DD) of the analysis window. When omitted, defaults to the earliest transaction available for the entity.

end_datestring date

The end date in UTC (in the format YYYY-MM-DD) of the analysis window (inclusive — transactions on this date are included). When omitted, defaults to the current time.

Response

OK

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

type of insight

Example response

{
  "insights": {
    "credit_obligations": {
      "repayments": {
        "overall": {
          "total_amount": {
            "currency": "AED"
          },
          "average_monthly_amount": {
            "currency": "AED"
          },
          "average_monthly_amount_active": {
            "currency": "AED"
          }
        },
        "breakdown": [
          {
            "total_amount": {
              "currency": "AED"
            },
            "average_monthly_amount": {
              "currency": "AED"
            },
            "average_monthly_amount_active": {
              "currency": "AED"
            }
          }
        ]
      },
      "disbursements": {
        "overall": {
          "total_amount": {
            "currency": "AED"
          },
          "average_monthly_amount": {
            "currency": "AED"
          },
          "average_monthly_amount_active": {
            "currency": "AED"
          }
        },
        "breakdown": [
          {
            "total_amount": {
              "currency": "AED"
            },
            "average_monthly_amount": {
              "currency": "AED"
            },
            "average_monthly_amount_active": {
              "currency": "AED"
            }
          }
        ]
      }
    }
  }
}