Sign in

v1

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

Get 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.

get/insights/v3/credit-assessments

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_assessments": {
      "income": {
        "employment_income": {
          "total_amount": {
            "currency": "AED"
          },
          "average_monthly_amount": {
            "currency": "AED"
          },
          "contributed_average_monthly_income": {
            "currency": "AED"
          }
        },
        "other_income": {
          "breakdown": [
            {
              "total_amount": {
                "currency": "AED"
              },
              "average_monthly_amount": {
                "currency": "AED"
              },
              "contributed_average_monthly_income": {
                "currency": "AED"
              }
            }
          ]
        },
        "total_contributed_average_monthly_income": {
          "currency": "AED"
        }
      },
      "expenses": {
        "average_monthly_credit_repayments": {
          "currency": "AED"
        },
        "average_monthly_essential_expenses": {
          "currency": "AED"
        },
        "average_monthly_discretionary_expenses": {
          "currency": "AED"
        },
        "average_monthly_total_expenses": {
          "currency": "AED"
        }
      },
      "balance": {
        "average_balance": {
          "currency": "AED"
        },
        "minimum_balance": {
          "currency": "AED"
        },
        "maximum_balance": {
          "currency": "AED"
        }
      },
      "computed_indicators": {
        "average_monthly_net_cashflow": {
          "currency": "AED"
        },
        "dbr": {
          "maximum_monthly_installment": {
            "currency": "AED"
          }
        },
        "affordability": {
          "maximum_monthly_installment": {
            "currency": "AED"
          }
        }
      }
    }
  }
}