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 secret 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": {
"id": "69f34242aabc802197562c8b",
"record": {
"businessId": "630c8be68231cd442344e790",
"borrowerId": "681cadbab56096b145bef413",
"accountNumber": "12345678902",
"annual_edti": "16.410205592079798",
"average_recurring_debt": 434534.4,
"average_monthly_balance": "37818.666666666664",
"number_of_active_months": "6",
"average_monthly_edti": "16.410205592079798",
"DTI_reason": "\n Please consider this range a reflection of healthy finances and ability to repay\n debt. This rating represents a \"good\" debt/expense level relative to his/her income,\n where this borrower \"most likely has money left over for saving or spending after\n bills are paid\n ",
"balance": {
"July 2024": 841751,
"August 2024": 974904,
"September 2024": 104843,
"October 2024": -651110,
"November 2024": -603468,
"December 2024": -440008
},
"EDTI": {
"December 2024": 14,
"October 2024": 40,
"September 2024": 14,
"August 2024": 13,
"July 2024": 1
},
"recurrent_expenses_debt": {
"December 2024": 370115,
"October 2024": 1059811,
"September 2024": 368889,
"August 2024": 344200,
"July 2024": 29657
},
"recurrent_debt_sum": 2172672,
"disposableIncome": 2213417.8000000003,
"monthlyDisposableIncome": [
{ "month": "2024-12", "disposable_income": 3820839 },
{ "month": "2024-11", "disposable_income": 47642 },
{ "month": "2024-10", "disposable_income": 4228524 },
{ "month": "2024-09", "disposable_income": 1741684 },
{ "month": "2024-08", "disposable_income": 1265004 },
{ "month": "2024-07", "disposable_income": 2084732 }
],
"averageMonthlyIncome": "2647952.2",
"totalMoneyReceive": "13239761",
"totalMoneySpent": "14131238",
"eligibleAmount": {
"15%": {
"3months": {
"monthly_amount": 397192.83,
"total_amount": 1191578.49
},
"6months": {
"monthly_amount": 397192.83,
"total_amount": 2383156.98
},
"12months": {
"monthly_amount": 397192.83,
"total_amount": 4766313.96
}
},
"25%": {
"3months": {
"monthly_amount": 661988.05,
"total_amount": 1985964.1500000001
},
"6months": {
"monthly_amount": 661988.05,
"total_amount": 3971928.3000000003
},
"12months": {
"monthly_amount": 661988.05,
"total_amount": 7943856.600000001
}
},
"30%": {
"3months": {
"monthly_amount": 794385.66,
"total_amount": 2383156.98
},
"6months": {
"monthly_amount": 794385.66,
"total_amount": 4766313.96
},
"12months": {
"monthly_amount": 794385.66,
"total_amount": 9532627.92
}
},
"33%": {
"3months": {
"monthly_amount": 873824.2260000001,
"total_amount": 2621472.6780000003
},
"6months": {
"monthly_amount": 873824.2260000001,
"total_amount": 5242945.356000001
},
"12months": {
"monthly_amount": 873824.2260000001,
"total_amount": 10485890.712000001
}
},
"40%": {
"3months": {
"monthly_amount": 1059180.8800000001,
"total_amount": 3177542.6400000006
},
"6months": {
"monthly_amount": 1059180.8800000001,
"total_amount": 6355085.280000001
},
"12months": {
"monthly_amount": 1059180.8800000001,
"total_amount": 12710170.560000002
}
},
"45%": {
"3months": {
"monthly_amount": 1191578.4900000002,
"total_amount": 3574735.4700000007
},
"6months": {
"monthly_amount": 1191578.4900000002,
"total_amount": 7149470.940000001
},
"12months": {
"monthly_amount": 1191578.4900000002,
"total_amount": 14298941.880000003
}
},
"50%": {
"3months": {
"monthly_amount": 1323976.1,
"total_amount": 3971928.3000000003
},
"6months": {
"monthly_amount": 1323976.1,
"total_amount": 7943856.600000001
},
"12months": {
"monthly_amount": 1323976.1,
"total_amount": 15887713.200000001
}
},
"60%": {
"3months": {
"monthly_amount": 1588771.32,
"total_amount": 4766313.96
},
"6months": {
"monthly_amount": 1588771.32,
"total_amount": 9532627.92
},
"12months": {
"monthly_amount": 1588771.32,
"total_amount": 19065255.84
}
},
"70%": {
"3months": {
"monthly_amount": 1853566.54,
"total_amount": 5560699.62
},
"6months": {
"monthly_amount": 1853566.54,
"total_amount": 11121399.24
},
"12months": {
"monthly_amount": 1853566.54,
"total_amount": 22242798.48
}
}
},
"totalBorrowed": "null",
"totalOutstanding": "null",
"totalOverdue": "null",
"creditInsight": "null",
"spendingAnalysis": {
"monthly": {
"2024-12": {
"atm": 250000,
"airtime": 0,
"transfers": 12463,
"party": 0,
"gambling": 0,
"titheOffering": 0,
"rent": 351777,
"tv": 0,
"investment": 0,
"loans": 0,
"education": 0,
"transport": 0,
"electricity": 0,
"tax": 0
},
"2024-11": {
"atm": 0,
"airtime": 0,
"transfers": 0,
"party": 0,
"gambling": 0,
"titheOffering": 0,
"rent": 0,
"tv": 0,
"investment": 0,
"loans": 0,
"education": 0,
"transport": 0,
"electricity": 0,
"tax": 0
},
"2024-10": {
"atm": 200000,
"airtime": 0,
"transfers": 1040799,
"party": 0,
"gambling": 0,
"titheOffering": 0,
"rent": 0,
"tv": 0,
"investment": 0,
"loans": 17112,
"education": 0,
"transport": 0,
"electricity": 0,
"tax": 0
},
"2024-09": {
"atm": 100000,
"airtime": 0,
"transfers": 0,
"party": 0,
"gambling": 0,
"titheOffering": 0,
"rent": 351777,
"tv": 0,
"investment": 0,
"loans": 17112,
"education": 0,
"transport": 0,
"electricity": 0,
"tax": 0
},
"2024-08": {
"atm": 114930,
"airtime": 0,
"transfers": 342300,
"party": 0,
"gambling": 0,
"titheOffering": 0,
"rent": 0,
"tv": 0,
"investment": 0,
"loans": 0,
"education": 0,
"transport": 0,
"electricity": 0,
"tax": 0
},
"2024-07": {
"atm": 0,
"airtime": 0,
"transfers": 10645,
"party": 0,
"gambling": 0,
"titheOffering": 0,
"rent": 0,
"tv": 0,
"investment": 0,
"loans": 17112,
"education": 0,
"transport": 0,
"electricity": 0,
"tax": 0
}
},
"total": {
"atm": 664930,
"airtime": 0,
"transfers": 1406207,
"party": 0,
"gambling": 0,
"titheOffering": 0,
"rent": 703554,
"tv": 0,
"investment": 0,
"loans": 51336,
"education": 0,
"transport": 0,
"electricity": 0,
"tax": 0
}
},
"titheOffering": {},
"salary": {
"narration": [
"MOB/UTO/PETER BEEBI/media team/35235253640 - FROM ISAIAH MAC",
"SUBSCRIPTION FOR MEDIA TEAM - FROM CELESTIAL CHURCH OF CHRIST NATIONAL HEAD 00001726010789517839242_CREDIT_0",
"FIP:MB:/WINNER ENERGY and /PETER BEEBI/DEPOSIT\n/PETER BEEBI - FROM WINNER ENERGY AND MARINE SERVICES LTD"
],
"amount": [2000000, 15000000, 1000000]
},
"creditBreakdown": {
"creditFirstHalf0": {},
"creditFirstHalf1": {},
"creditFirstQuarter0": {},
"creditFirstQuarter1": {},
"creditFourthQuarter0": {
"October 2024": 4245636,
"November 2024": 47642,
"December 2024": 3820839
},
"creditFourthQuarter1": {},
"creditSecondHalf0": {
"July 2024": 2101844,
"August 2024": 1265004,
"September 2024": 1758796,
"October 2024": 4245636,
"November 2024": 47642,
"December 2024": 3820839
},
"creditSecondHalf1": {},
"creditSecondQuarter0": {},
"creditSecondQuarter1": {},
"creditThirdQuarter0": {
"July 2024": 2101844,
"August 2024": 1265004,
"September 2024": 1758796
},
"creditThirdQuarter1": {},
"dailyAverageDeposit": "78808.10119047618",
"dailyAverageWithdrawal": "84114.51190476191",
"weeklyAverageDeposit": "551656.7083333334",
"weeklyAverageWithdrawal": "588801.5833333334",
"debitFirstHalf0": {},
"debitFirstHalf1": {},
"debitFirstQuarter0": {},
"debitFirstQuarter1": {},
"debitFourthQuarter0": {
"October 2024": 4649812,
"December 2024": 4009156
},
"debitFourthQuarter1": {},
"debitSecondHalf0": {
"July 2024": 1359785,
"August 2024": 1131851,
"September 2024": 2980634,
"October 2024": 4649812,
"December 2024": 4009156
},
"debitSecondHalf1": {},
"debitSecondQuarter0": {},
"debitSecondQuarter1": {},
"debitThirdQuarter0": {
"July 2024": 1359785,
"August 2024": 1131851,
"September 2024": 2980634
},
"debitThirdQuarter1": {},
"monthlyCredit": {
"July 2024": 2101844,
"August 2024": 1265004,
"September 2024": 1758796,
"October 2024": 4245636,
"November 2024": 47642,
"December 2024": 3820839
},
"monthlyDebit": {
"July 2024": 1359785,
"August 2024": 1131851,
"September 2024": 2980634,
"October 2024": 4649812,
"December 2024": 4009156
},
"max_bal_day_list_dict": [243],
"max_bal_week_list_dict": [35],
"max_depo_day_list_dict": [302],
"max_depo_week_list_dict": [44],
"min_depo_week_list_dict": [52],
"min_bal_days_list_dict": [337],
"min_bal_week_list_dict": [49],
"numberOfActiveMonths": "6",
"perCredTrans": "42.17821782178218",
"perDebTrans": "57.821782178217816",
"negBalDays": "253",
"aveSweepMonthlyCred": "20.4",
"averageDailyBal": "117871.88642660758",
"highestBalance": "1032294",
"lowestBalance": "-943021",
"maxCredit": "419250",
"min_crebit": "100",
"meanCredit": "62158.50234741784",
"maxDebit": "690000",
"minDebit": "11",
"meanDebit": "48394.650684931505",
"averageAnnualEdti": 18.040191960714964,
"averageAMonthlyIncome": 29169319.663899872,
"averageMeanDebit": 2382994.622544793,
"averageMaxDebit": 73251137.45454545,
"averageMaxCredit": 80652198.54545455,
"averageMinDebit": 2924.840909090909,
"averageMinCredit": 53483.454545454544,
"averageMeanCredit": 14463403.000167094,
"averageAWeeklyBal": 48229597.25900145,
"averageASweepMonthlyCred": 38.11437251947952,
"averageADailyBal": 55495792.01389684,
"averagePerDebTrans": 77.89899881249924,
"averagePerCredTrans": 22.10100118750075,
"averageNegBalDays": 15.021739130434783,
"averageTotalBorrowed": 11827015,
"averageTotalOverdue": 328511.25,
"averageTotalOutstanding": 370682,
"averageEligibleAmount": 117298916.521561,
"averageAMonthlyBalance": 47852425.42179614,
"averageTotalMoneyReceived": 426442982.0869565,
"averageDailyAverageWithdrawal": 2228338.9434476756,
"averageDailyAverageDeposit": 2641989.745360493,
"averageWeeklyAverageWithdrawal": 15598372.604133727,
"averageWeeklyAverageDeposit": 18493928.217523452,
"averageMonthlyAverageWithdrawal": 62393490.41653491,
"averageMonthlyAverageDeposit": 73975712.87009381,
"averageHighestBalance": 147535899.933,
"averageLowestBalance": 33681.066999999995,
"subscriptionsAndDirectDebits": []
}
},
"metadata": {
"name": "income response",
"readCountRemaining": 96,
"timeToExpire": 83840,
"createdAt": "2026-04-30T11:51:30.031Z"
}
}
}