---
title: "Get Credit Assessments"
method: GET
path: "/insights/v3/credit-assessments"
tags: ["Credit Assessments (New)"]
---

# Get Credit Assessments

`GET /insights/v3/credit-assessments`

Aggregates income, expenses, and balance into pre-computed credit indicators for DBR, affordability ratio, 
net cashflow, and max installment capacity. This endpoint offers configuration capabilities in order to fit and calibrate to your credit policy.

## Query parameters

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

## Response `200`

OK

- object
  - `insights` CreditAssessmentPayload — Insights payload wrapper carrying the credit evaluation data
    - `credit_assessments` CreditAssessments, required — Credit evaluation data including income, expenses, balance, and computed indicators.
      - `income` CreditAssessmentIncome, required — Income components used in credit assessment.
        - `employment_income` CreditAssessmentEmploymentIncome, required — Employment income details for credit assessment.
          - `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.
          - `contribution_factor` number, required — Factor applied to weight employment income in the overall income calculation. Range is 0.0 to 1.0.
          - `contributed_average_monthly_income` CurrencyAmount, required
            - `currency` string, required — The ISO 3 letter currency code
            - `amount` number, required — The amount of money in the currency specified.
        - `other_income` CreditAssessmentOtherIncome, required — Non-employment income sources for credit assessment.
          - `breakdown` CreditAssessmentOtherIncomeBreakdownItem[], required — Breakdown of non-employment income by source.
            - `source` 'EMPLOYMENT' | 'RETIREMENT' | 'HOUSING_BENEFIT' | 'GIG_ECONOMY' | 'UNEMPLOYMENT' | 'RENTAL' | 'TRANSFER_FROM_OWN_APPLICATION' | 'STUDENT_STIPEND' | 'INVESTMENTS' | 'CITIZEN_ACCOUNT' | 'SOCIAL_SECURITY' | 'SIDE_BUSINESS' | 'BONUS' | 'CASH_DEPOSIT', required — Classification of income source type (combined enum for all income sources)
            - `total_amount` CurrencyAmount, required
              - …
            - `average_monthly_amount` CurrencyAmount, required
              - …
            - `contribution_factor` number, required — Factor applied to weight this income source in the overall income calculation. Range is 0.0 to 1.0.
            - `contributed_average_monthly_income` CurrencyAmount, required
              - …
        - `total_contributed_average_monthly_income` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
      - `expenses` CreditAssessmentExpenses, required — Monthly expense breakdown used for credit assessment.
        - `average_monthly_credit_repayments` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `average_monthly_essential_expenses` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `average_monthly_discretionary_expenses` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `average_monthly_total_expenses` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `defined_essential_categories` string[], required — List of expense categories classified as essential for this evaluation.
      - `balance` CreditAssessmentBalance, required — Balance statistics over the analysis period.
        - `average_balance` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `minimum_balance` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `maximum_balance` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
      - `computed_indicators` CreditAssessmentComputedIndicators, required — Derived financial indicators used in credit assessment decisions.
        - `average_monthly_net_cashflow` CurrencyAmount, required
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `dbr` CreditAssessmentRatioIndicator, required — A ratio-based credit indicator including the computed rate, regulatory ceiling, and derived maximum installment.
          - `rate` number, required — The computed ratio as a decimal between 0 and 1.
          - `ceiling` number, required — The regulatory or policy ceiling for this ratio as a decimal between 0 and 1.
          - `maximum_monthly_installment` CurrencyAmount, required
            - `currency` string, required — The ISO 3 letter currency code
            - `amount` number, required — The amount of money in the currency specified.
        - `affordability` CreditAssessmentRatioIndicator, required — A ratio-based credit indicator including the computed rate, regulatory ceiling, and derived maximum installment.
          - `rate` number, required — The computed ratio as a decimal between 0 and 1.
          - `ceiling` number, required — The regulatory or policy ceiling for this ratio as a decimal between 0 and 1.
          - `maximum_monthly_installment` CurrencyAmount, required
            - `currency` string, required — The ISO 3 letter currency code
            - `amount` number, required — The amount of money in the currency specified.
  - `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

## Other responses

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

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)