Get Existing Income Insights

This Endpoint allows to fetch the existing insight data for a borrower

• Debt Burden Ration - This number is used by banks to calculate the borrowers' eligibility for loans and credit cards as it shows their current liabilities and their ability to pay back
• Average Monthly Income
• Total money received
• Total money spent
• Estimated monthly recurring expenses
• Recommended loan amount
• Monthly seating balance

GET: https://api.creditchek.africa/v1/income/insight-data/${borrowerId}

Request Parameters

Name	Position	Required	Description
token	Headers	True	app public key
borrowerId	Params	True	borrower's id

Example Request

---
curl --location --request GETT 'https://api.creditchek.africa/v1/income/insight-data/64cbb1ccb1cdd033fc2334f8' \
--header 'token: w5BNzmL8ypY6mumPtqXc72yk0Ksz6aI9A+K9wiO6oQipnlmCSTClvgl6vHdZqWBv' \
---

Sample webhook Response

{
  "status": "success",
  "message": "success",
  "data": {
    "EDTI": {
      "businessId": "62628a43522d450014c6ee40",
      "borrowerId": "64cbb1ccb1cdd033fc2334f8",
      "average_monthly_income": "12016322.866666667",
      "annual_edti": "3.5394832350349135",
      "average_monthly_balance": "1997918.1666666667",
      "average_monthly_recurring_debt_expenses": "1275947.2",
      "number_of_active_months": "6",
      "average_monthly_edti": "10.618449705104737",
      "DTI_reason": "Please consider this range a reflection of healthy finances and ability to repay debt. This rating represents a \"good\" debt/expense level relative to his/her income, where this borrower \"most likely has money left over for saving or spending after bills are paid",
      "balance": {
        "December 2022": 6879139,
        "January 2023": 51485,
        "February 2023": 1013170,
        "March 2023": 237537,
        "April 2023": 2228215,
        "May 2023": 1577963
      },
      "EDTI": {
        "May 2023": 4,
        "April 2023": 18,
        "March 2023": 1,
        "February 2023": 7,
        "January 2023": 22
      },
      "recurrent_expenses_debt": {
        "May 2023": 519080,
        "April 2023": 2206955,
        "March 2023": 106181,
        "February 2023": 859621,
        "January 2023": 2687899
      },
      "recurrent_debt_sum": 6379736,
      "averageMonthlyIncome": "12016322.866666667",
      "totalMoneyReceive": "180244843",
      "totalMoneySpent": "185563613",
      "eligibleAmount": "47584638.552",
      "totalBorrowed": "null",
      "totalOutstanding": "null",
      "totalOverdue": "null",
      "creditInsight": "null",
      "spendingAnalysis": {
        "atm": [0],
        "airtime": [1000000],
        "transfers": [157782515],
        "party": [430000],
        "gambling": [0],
        "titheOffering": [0],
        "rent": [0],
        "tv": [0],
        "investment": [0],
        "loans": [0],
        "education": [0],
        "transport": [0],
        "electricity": [0],
        "tax": [141900]
      },
      "titheOffering": {},
      "airtime": {
        "February 2023": 400000,
        "March 2023": 100000,
        "May 2023": 500000
      },
      "atm": {},
      "gambling": {},
      "tv": {},
      "investment": {},
      "loans": {},
      "party": {
        "April 2023": 430000
      },
      "rent": {},
      "transfers": {
        "December 2022": 702149,
        "January 2023": 38917274,
        "February 2023": 22640216,
        "March 2023": 33522577,
        "April 2023": 31984173,
        "May 2023": 30016126
      },
      "transport": {},
      "education": {},
      "salary": {
        "narration": [],
        "amount": []
      },
      "creditBreakdown": {
        "creditFirstHalf0": {
          "January 2023": 34743947,
          "February 2023": 30007123,
          "March 2023": 33262124,
          "April 2023": 50302123,
          "May 2023": 31244980
        },
        "creditFirstHalf1": {},
        "creditFirstQuarter0": {
          "January 2023": 34743947,
          "February 2023": 30007123,
          "March 2023": 33262124
        },
        "creditFirstQuarter1": {},
        "creditFourthQuarter0": {},
        "creditFourthQuarter1": {
          "December 2022": 684546
        },
        "creditSecondHalf0": {},
        "creditSecondHalf1": {
          "December 2022": 684546
        },
        "creditSecondQuarter0": {
          "April 2023": 50302123,
          "May 2023": 31244980
        },
        "creditSecondQuarter1": {},
        "creditThirdQuarter0": {},
        "creditThirdQuarter1": {},
        "dailyAverageDeposit": "1072885.9702380951",
        "dailyAverageWithdrawal": "1104545.3154761905",
        "weeklyAverageDeposit": "7510201.791666667",
        "weeklyAverageWithdrawal": "7731817.208333333",
        "debitFirstHalf0": {
          "January 2023": 41571598,
          "February 2023": 29045437,
          "March 2023": 34037757,
          "April 2023": 48311441,
          "May 2023": 31895231
        },
        "debitFirstHalf1": {},
        "debitFirstQuarter0": {
          "January 2023": 41571598,
          "February 2023": 29045437,
          "March 2023": 34037757
        },
        "debitFirstQuarter1": {},
        "debitFourthQuarter0": {},
        "debitFourthQuarter1": {
          "December 2022": 702149
        },
        "debitSecondHalf0": {},
        "debitSecondHalf1": {
          "December 2022": 702149
        },
        "debitSecondQuarter0": {
          "April 2023": 48311441,
          "May 2023": 31895231
        },
        "debitSecondQuarter1": {},
        "debitThirdQuarter0": {},
        "debitThirdQuarter1": {},
        "monthlyCredit": {
          "December 2022": 684546,
          "January 2023": 34743947,
          "February 2023": 30007123,
          "March 2023": 33262124,
          "April 2023": 50302123,
          "May 2023": 31244980
        },
        "monthlyDebit": {
          "December 2022": 702149,
          "January 2023": 41571598,
          "February 2023": 29045437,
          "March 2023": 34037757,
          "April 2023": 48311441,
          "May 2023": 31895231
        },
        "max_bal_day_list_dict": [48],
        "max_bal_week_list_dict": [7],
        "max_depo_day_list_dict": [145],
        "max_depo_week_list_dict": [21],
        "min_bal_days_list_dict": [16, 13],
        "min_bal_week_list_dict": [3, 2],
        "numberOfActiveMonths": "6",
        "perCredTrans": "10.699588477366255",
        "perDebTrans": "89.30041152263375",
        "negBalDays": "0",
        "aveSweepMonthlyCred": "29.5",
        "averageDailyBal": "6855493.832656742",
        "maxCredit": "17283221",
        "min_crebit": "0",
        "meanCredit": "6932493.961538462",
        "maxDebit": "20000000",
        "minDebit": "1",
        "meanDebit": "855131.8571428572"
      }
    },
    "transactions": [
      {
        "type": "debit",
        "narration": "Web Purchase from PSK*Boolean Li Ikeja NG Ref: FT23150D86J3",
        "amount": 99000,
        "date": "2023-05-30T00:00:00Z",
        "balance": 1577963,
        "bankCode": "232"
      },
      {
        "type": "debit",
        "narration": "Airtime Purchase for 09039830430 Ref: FT2315008QF8",
        "amount": 500000,
        "date": "2023-05-30T00:00:00Z",
        "balance": 1676963,
        "bankCode": "232"
      },
      {
        "type": "debit",
        "narration": "NIPVAT/OneBank Transfer from ADEYEM O OLUWATUNMISE MICHAEL to ADEYEMO O LUWATUNMISE MICHAEL(salary Ref: FT23150527M6- SBN",
        "amount": 375,
        "date": "2023-05-30T00:00:00Z",
        "balance": 2176963,
        "bankCode": "232"
      },
      {
        "type": "debit",
        "narration": "NIPFEE/OneBank Transfer from ADEYEM O OLUWATUNMISE MICHAEL to ADEYEMO o LUWATUNMISE MICHAEL(salary Ref: FT23150SRYK4",
        "amount": 5000,
        "date": "2023-05-30T00:00:00Z",
        "balance": 2177338,
        "bankCode": "232"
      },
      {
        "type": "debit",
        "narration": "OneBank Transfer from ADEYEMO OLUWA TUNMISE MICHAEL to ADEYEMO OLUWATUN MISE MICHAEL(salar Ref: FT23150V6321-SBN",
        "amount": 12000000,
        "date": "2023-05-30T00:00:00Z",
        "balance": 2182338,
        "bankCode": "232"
      },
      {
        "type": "debit",
        "narration": "POS Purchase from GRANDVIEW B AND B RETAILA LANG Ref: FT23146KK2GB",
        "amount": 1023000,
        "date": "2023-05-26T00:00:00Z",
        "balance": 14182338,
        "bankCode": "232"
      }
    ]
  }
}