Get Income Insights

This Endpoint allows you to compute the data extracted from the Uploaded PDF statement, as a way to derive deep insights into the financial strength of the intended borrower. Here we help your business discover actionable financial data points as the following:

• 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

POST: https://api.creditchek.africa/v1/income/api/process-income

You can simulate sample webhooks and response by using BVN: 12345678901 and 98765432101

Request Parameters

Name	Position	Required	Description
token	Headers	True	app public key
bvn	body	True	borrower's bvn
accountName	body	True	account name
accountNumber	body	True	account number
accountType	body	True	account type
bankName	body	True	bank name
bankCode	body	True	bank short code
password	body	False	pdf password
statement	body	True	pdf file

Example Request

---
curl --location --request POST 'https://api.creditchek.africa/v1/income/api/process-income' \
--header 'token: w5BNzmL8ypY6mumPtqXc72yk0Ksz6aI9A+K9wiO6oQipnlmCSTClvgl6vHdZqWBv' \
--form 'bankName="fidelity bank"' \
--form 'bankCode="070"' \
--form 'accountName="Tet Jorm"' \
--form 'accountNumber="7160010613"' \
--form 'accountType="savings"' \
--form 'bvn="22357999900"' \
--form 'statement=@"/Users/josh/Downloads/mybankstatement-fidelity.pdf"'
---

Sample webhook Response

{
  "event": "income_insight",
  "data": {
    "success": true,
    "businessId": "6287757348cc6c0013f4d0a0",
    "borrowerId": "64c8c1d11c73fbbc988092f5",
    "average_monthly_income": "5936317.13",
    "annual_edti": "3.68",
    "average_monthly_balance": "472967.14",
    "average_monthly_recurring_debt_expenses": "547087.67",
    "number_of_active_months": "7",
    "average_monthly_edti": "9.215944067318864",
    "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": {
      "January 2023": 2106864,
      "February 2023": 32516,
      "March 2023": 2656,
      "April 2023": 8809,
      "May 2023": 1051,
      "June 2023": 5574,
      "July 2023": 1153300
    },
    "EDTI": {
      "July 2023": 2,
      "June 2023": 12,
      "May 2023": 0,
      "April 2023": 0,
      "February 2023": 24,
      "January 2023": 17
    },
    "recurrent_expenses_debt": {
      "July 2023": 105334,
      "June 2023": 724974,
      "May 2023": 2000,
      "April 2023": 3600,
      "February 2023": 1441779,
      "January 2023": 1004839
    },
    "recurrent_debt_sum": 3282526,
    "averageMonthlyIncome": "5936317.13",
    "totalMoneyReceive": "89044757",
    "totalMoneySpent": "88522716",
    "eligibleAmount": "23507815.85",
    "totalBorrowed": "null",
    "totalOutstanding": "null",
    "totalOverdue": "null",
    "creditInsight": "null",
    "spendingAnalysis": {
      "atm": [0],
      "airtime": [2379999],
      "transfers": [65271],
      "party": [0],
      "gambling": [0],
      "titheOffering": [0],
      "rent": [0],
      "tv": [0],
      "investment": [0],
      "loans": [0],
      "education": [0],
      "transport": [0],
      "electricity": [0],
      "tax": [2445830]
    },
    "titheOffering": {},
    "airtime": {
      "January 2023": 240000,
      "February 2023": 1330000,
      "June 2023": 709999,
      "July 2023": 100000
    },
    "atm": {},
    "gambling": {},
    "tv": {},
    "investment": {},
    "loans": {},
    "party": {},
    "rent": {},
    "transfers": {
      "January 2023": 10000,
      "February 2023": 35000,
      "April 2023": 271,
      "May 2023": 5000,
      "June 2023": 15000
    },
    "transport": {},
    "education": {},
    "salary": {
      "narration": [],
      "amount": []
    },
    "creditBreakdown": {
      "creditFirstHalf0": {
        "January 2023": 7919998,
        "February 2023": 38750112,
        "March 2023": 7593447,
        "April 2023": 5655399,
        "May 2023": 7666649,
        "June 2023": 12664267
      },
      "creditFirstHalf1": {},
      "creditFirstQuarter0": {
        "January 2023": 7919998,
        "February 2023": 38750112,
        "March 2023": 7593447
      },
      "creditFirstQuarter1": {},
      "creditFourthQuarter0": {},
      "creditFourthQuarter1": {},
      "creditSecondHalf0": {
        "July 2023": 8794885
      },
      "creditSecondHalf1": {},
      "creditSecondQuarter0": {
        "April 2023": 5655399,
        "May 2023": 7666649,
        "June 2023": 12664267
      },
      "creditSecondQuarter1": {},
      "creditThirdQuarter0": {
        "July 2023": 8794885
      },
      "creditThirdQuarter1": {},
      "dailyAverageDeposit": "454309.98",
      "dailyAverageWithdrawal": "451646.51",
      "weeklyAverageDeposit": "3180169.89",
      "weeklyAverageWithdrawal": "3161525.57",
      "debitFirstHalf0": {
        "January 2023": 6444404,
        "February 2023": 40824454,
        "March 2023": 7623308,
        "April 2023": 5649246,
        "May 2023": 7674404,
        "June 2023": 12659741
      },
      "debitFirstHalf1": {},
      "debitFirstQuarter0": {
        "January 2023": 6444404,
        "February 2023": 40824454,
        "March 2023": 7623308
      },
      "debitFirstQuarter1": {},
      "debitFourthQuarter0": {},
      "debitFourthQuarter1": {},
      "debitSecondHalf0": {
        "July 2023": 7647159
      },
      "debitSecondHalf1": {},
      "debitSecondQuarter0": {
        "April 2023": 5649246,
        "May 2023": 7674404,
        "June 2023": 12659741
      },
      "debitSecondQuarter1": {},
      "debitThirdQuarter0": {
        "July 2023": 7647159
      },
      "debitThirdQuarter1": {},
      "monthlyCredit": {
        "January 2023": 7919998,
        "February 2023": 38750112,
        "March 2023": 7593447,
        "April 2023": 5655399,
        "May 2023": 7666649,
        "June 2023": 12664267,
        "July 2023": 8794885
      },
      "monthlyDebit": {
        "January 2023": 6444404,
        "February 2023": 40824454,
        "March 2023": 7623308,
        "April 2023": 5649246,
        "May 2023": 7674404,
        "June 2023": 12659741,
        "July 2023": 7647159
      },
      "max_bal_day_list_dict": [41],
      "max_bal_week_list_dict": [6],
      "max_depo_day_list_dict": [41],
      "max_depo_week_list_dict": [6],
      "min_bal_days_list_dict": [151],
      "min_bal_week_list_dict": [22],
      "numberOfActiveMonths": "7",
      "perCredTrans": "22.96",
      "perDebTrans": "77.04",
      "negBalDays": "0",
      "aveSweepMonthlyCred": "34.4",
      "averageDailyBal": "2193525.89",
      "maxCredit": "10000000",
      "min_crebit": "15",
      "meanCredit": "1978772.37",
      "maxDebit": "9300000",
      "minDebit": "2",
      "meanDebit": "586243.15"
    }
  }
}