---
title: "Get Credit Obligations"
method: GET
path: "/insights/v3/credit-obligations"
tags: ["Credit Obligations (NEW)"]
---

# Get Credit Obligations

`GET /insights/v3/credit-obligations`

## Request

- Base URL: `https://sandbox.leantech.me`
- URL: `https://sandbox.leantech.me/insights/v3/credit-obligations`
- Auth: HTTP bearer

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.

## Query parameters

- `entity_id` string, uuid, required
- `start_date` string, date
- `end_date` string, date

## Response `200`

OK

- object
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required: The status of the request
  - `results_id` string, uuid, required: The unique identifier for the request
  - `message` string, required: A message describing the status of the request
  - `meta` object, nullable: Meta information about the request
  - `timestamp` string, date-time, required: The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable: Granular status code
    - `status_additional_info` string, nullable: Additional information about the status
  - `insights` CreditObligationsV2Payload: Insights payload wrapper carrying the lender-oriented credit-obligations
    - `credit_obligations` CreditObligationsV2, required: Lender-oriented view of credit activity, split into repayments and disbursements.
      - `repayments` CreditObligationsRepayments, required: Repayment aggregates and breakdown by lender_name, credit_type.
        - `overall` CreditObligationsOverall, required: Aggregate totals across all lenders for a credit activity type.
          - `transaction_count` integer, required: Total number of transactions across all lenders.
          - `total_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount_active` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_transactions` number, double, required: Average number of transactions per month across the full analysis window (all months, not just active months).
          - `active_months` integer, required: Number of months that contained at least one transaction.
          - `lender_count` integer, required: Number of distinct lender organizations detected.
          - `lender_organizations` string[], required: Distinct lender organization names detected.
        - `breakdown` CreditObligationsRepaymentBreakdown[], required: One entry per lender that received repayments.
          - `lender_name` string, required: Lender organization name.
          - `credit_type` string, required: The type of credit product (e.g. "BNPL").
          - `transaction_count` integer, required: Number of repayment transactions with this lender.
          - `total_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount_active` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `first_transaction_date` string, date, required: Date of the first repayment transaction with this lender.
          - `last_transaction_date` string, date, required: Date of the most recent repayment transaction with this lender.
          - `active_months` integer, required: Number of months with at least one repayment to this lender.
      - `disbursements` CreditObligationsDisbursements, required: Disbursement aggregates and breakdown by lender_name.
        - `overall` CreditObligationsOverall, required: Aggregate totals across all lenders for a credit activity type.
          - `transaction_count` integer, required: Total number of transactions across all lenders.
          - `total_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount_active` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_transactions` number, double, required: Average number of transactions per month across the full analysis window (all months, not just active months).
          - `active_months` integer, required: Number of months that contained at least one transaction.
          - `lender_count` integer, required: Number of distinct lender organizations detected.
          - `lender_organizations` string[], required: Distinct lender organization names detected.
        - `breakdown` CreditObligationsDisbursementBreakdown[], required: One entry per lender that disbursed credit.
          - `lender_name` string, required: Lender organization name.
          - `transaction_count` integer, required: Number of disbursement transactions from this lender.
          - `total_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `average_monthly_amount_active` CurrencyAmount, required
            - `currency` string, required: The ISO 3 letter currency code
            - `amount` number, required: The amount of money in the currency specified.
          - `first_transaction_date` string, date, required: Date of the first disbursement transaction from this lender.
          - `last_transaction_date` string, date, required: Date of the most recent disbursement transaction from this lender.
          - `active_months` integer, required: Number of months with at least one disbursement from this lender.
  - `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

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `408`: Request Timeout
- `500`: Internal Server Error

---

[API](https://skmtc.dev/leantech/apis/insights-api-account-controls.md) - [All operations](https://skmtc.dev/leantech/apis/insights-api-account-controls/llms.txt) - [OpenAPI document](https://skmtc.dev/leantech/apis/insights-api-account-controls/revisions/6a904c24f1e4?raw)