You can now easily connect your account and have insights generated from the Mono statement with just a connect URL
How it works
-
Periculum generates a tenant specific URL that clients can connect their account with.
-
Once the client account is connected, insights are automatically generated from the statement that was received from Mono.
-
Insights generated can be viewed on the dashboard and also retrieved using an endpoint call (Get Statements By Unique Code)
-
This service can also be featured flagged to require an 8 digit unique alphanumeric code, that can be used to retrieve the processed statement.
-
Webhook can also be sent on a successful account connection to the provided URL
-
To check if the client successfully connected their account, and track the statement processing status; you can call the (Get Processing Status By Unique Code endpoint ) on the next page.
-
To get the analysis response, you can either call the (Get Statements By Unique Code endpoint ) or subscribe to the webhook service
Document that describes the whole process
drive.google.comGet Statement By Unique Code
This endpoint is used to get statement by Unique Code
| Method | Endpoint | Headers | Parameters | Body |
|---|---|---|---|---|
| GET | https://api.insights-periculum.com/statements/uniqueCode/{uniqueCode} | Authorization value: Bearer string_encrypted_access_token | None | None |
Response
{
"key": 1011,
"uniqueCode": "uht6f4s3",
"name": "test",
"source": "test",
"clientFullName": "test",
"clientPhoneNumber": null,
"accountType": "UNIFI ACCOUNT - SAVINGS",
"accountBalance": null,
"accountId": null,
"accountName": null,
"bankName": "Unity Bank",
"statementType": "CONSUMER",
"startDate": "2021-08-11T00:00:00+00:00",
"endDate": "2021-08-11T00:00:00+00:00",
"createdDate": "2022-07-04T14:02:51.493+00:00",
"processingStatus": "PROCESSED",
"clientIdentification": [
{
"identifierName": "bvn",
"identifierValue": null
},
{
"identifierName": "nin",
"identifierValue": null
}
],
"spendAnalysis": {
"averageMonthlySpendOnTransfer": 33171.16,
"averageMonthlySpendOnAtmAndPOS": 0,
"averageMonthlySpendOnUSSD": 0,
"averageMonthlySpendOnGambling": 0,
"averageMonthlySpendOnAirtimeAndData": 0,
"averageMonthlySpendOnUtilities": 0,
"averageMonthlySpendOnOnlineAndWeb": 0,
"averageMonthlySpendOnTransportation": 0,
"averageMonthlySpendOnHealth": 0,
"averageMonthlySpendOnTravel": 0,
"averageMonthlySpendOnEntertainment": 0,
"averageMonthlySpendOnHospitalityAndFood": 0,
"averageMonthlySpendOnRent": 0,
"averageMonthlySpendOnInsurance": 0,
"averageMonthlySpendOnChargesAndStampDuty": 47.07,
"averageMonthlySpendOnInternationalTransactions": 0,
"averageMonthlyTotalExpenses": 33154.55,
"averageMonthlyRecurringExpense": 21090.91,
"averageMonthlySpendOnSavingsAndInvestments": 0,
"averageMonthlySpendOnOthers": 0,
"mostRecurringExpense": "transfer_transactions",
"totalSpendOnTransfer": 364882.78,
"totalSpendOnAtmAndPOS": 0,
"totalSpendOnUSSD": 0,
"totalSpendOnGambling": 0,
"totalSpendOnAirtimeAndData": 0,
"totalSpendOnUtilities": 0,
"totalSpendOnOnlineAndWeb": 0,
"totalSpendOnTransportation": 0,
"totalSpendOnHealth": 0,
"totalSpendOnTravel": 0,
"totalSpendOnEntertainment": 0,
"totalSpendOnHospitalityAndFood": 0,
"totalSpendOnRent": 0,
"totalSpendOnInsurance": 0,
"totalSpendOnChargesAndStampDuty": 517.78,
"totalSpendOnInternationalTransactions": 0,
"totalMonthlyExpenses": 364700,
"totalRecurringExpense": 232000,
"totalExpenses": 364700,
"totalMonthlyExpense": 0,
"totalSpendOnSavingsAndInvestments": 0,
"totalSpendOnOthers": 0,
"atmLocations": [],
"mostFrequentSpendCategory": "transfer_transactions",
"monthWithHighestSpend": "11/2021",
"highestSpend": 120307.5,
"mostFrequentExpense": "electronic money transfer levy 12th aug 2021 electronic money transfer levy",
"mostFrequentExpenseAmount": 50
},
"transactionPatternAnalysis": {
"lastDayOfCredit": "2022-06-30",
"lastDayOfDebit": "2022-07-03",
"percentDebitTransactions": 0.67,
"percentCreditTransactions": 0.33,
"totalNumberOfTransactions": 67,
"percentOfTransactionsLessThan10ThousandNaira": 0.69,
"percentOfTransactionsBetween10ThousandTo100ThousandNaira": 0.31,
"percentOfTransactionsBetween100ThousandTo500ThousandNaira": 0,
"percentOfTransactionsBetween500ThousandToOneMillionNaira": 0,
"percentOfTransactionsGreaterThanOneMillionNaira": 0,
"percentNumberOfDaysTransactionsWasLessThan10ThousandNaira": 0.88,
"percentOfBalancesLessThan10ThousandNaira": 0.57,
"percentOfBalancesBetween10ThousandTo100ThousandNaira": 0.43,
"percentOfBalancesBetween100ThousandTo500ThousandNaira": 0,
"percentOfBalancesBetween500ThousandToOneMillionNaira": 0,
"percentOfBalancesGreaterThanOneMillionNaira": 0,
"percentNumberOfDaysBalanceWasLessThan10ThousandNaira": 0.67,
"mostFrequentBalanceRange": "<10000",
"mostFrequentTransactionRange": "<10000",
"numberOfCardRequests": 0,
"topIncomingTransfer": null,
"mostFrequentCreditTransfer": null,
"mostFrequentDebitTransfer": "unifi",
"topOutgoingTransfer": null,
"returnCheque": 0,
"missingTransactions": null,
"balanceBreakdown": [
{
"min": -1E+18,
"max": 10000,
"percentageOfTransactionsInBucket": 0.57
},
{
"min": 10000,
"max": 100000,
"percentageOfTransactionsInBucket": 0.43
},
{
"min": 100000,
"max": 500000,
"percentageOfTransactionsInBucket": 0
},
{
"min": 500000,
"max": 1000000,
"percentageOfTransactionsInBucket": 0
},
{
"min": 1000000,
"max": 1E+18,
"percentageOfTransactionsInBucket": 0
}
],
"transactionBreakdown": [
{
"min": -1E+18,
"max": 10000,
"percentageOfTransactionsInBucket": 0.64
},
{
"min": 10000,
"max": 100000,
"percentageOfTransactionsInBucket": 0.36
},
{
"min": 100000,
"max": 500000,
"percentageOfTransactionsInBucket": 0
},
{
"min": 500000,
"max": 1000000,
"percentageOfTransactionsInBucket": 0
},
{
"min": 1000000,
"max": 1E+18,
"percentageOfTransactionsInBucket": 0
}
],
"percentNumberOfDaysTransactionsInSmallestBucket": 0.84,
"percentNumberOfDaysBalancesInSmallestBucket": 0.67
},
"behavioralAnalysis": {
"monthToMonthInflowToOutflowRate": "Equal Cash Flow",
"overallInflowToOutflowRate": "Positive Cash Flow",
"totalLoanAmount": 0,
"totalLoanRepaymentAmount": 0,
"loanInflowRate": null,
"loanRepaymentToInflowRate": 0,
"numberOfCreditLoanTransactions": null,
"numberOfDebitRepaymentTransactions": null,
"gamblingStatus": "No Gambling Transactions Found",
"gamblingRate": 0,
"accountActivity": 0,
"percentOfInflowIrregularity": 0.23,
"averageMonthlyLoanAmount": 0,
"averageMonthlyLoanRepaymentAmount": 0,
"numberLoanTransactions": null,
"numberRepaymentTransactions": null,
"loanToInflowRate": null,
"accountSweep": "No"
},
"cashFlowAnalysis": {
"totalCreditTurnover": 365218.44,
"totalDebitTurnOver": 365217.78,
"averageMonthlyCredits": 33201.68,
"averageMonthlyDebits": 30434.82,
"averageWeeklyCredits": 7770.61,
"averageWeeklyDebits": 7770.59,
"averageMonthlyBalance": 17264.52,
"averageWeeklyBalance": 17468.3,
"numberOfTransactingMonths": 11,
"monthlyOutflow": [
{
"year": "2021",
"month_name": "August",
"amount": 11771.5
},
{
"year": "2021",
"month_name": "September",
"amount": 53.75
},
{
"year": "2021",
"month_name": "October",
"amount": 50
},
{
"year": "2021",
"month_name": "November",
"amount": 120307.5
},
{
"year": "2021",
"month_name": "December",
"amount": 33204.88
},
{
"year": "2022",
"month_name": "February",
"amount": 32603.75
},
{
"year": "2022",
"month_name": "March",
"amount": 66303.76
},
{
"year": "2022",
"month_name": "April",
"amount": 102
},
{
"year": "2022",
"month_name": "May",
"amount": 32888.88
},
{
"year": "2022",
"month_name": "June",
"amount": 67881.76
},
{
"year": "2022",
"month_name": "July",
"amount": 50
}
],
"monthlyInflow": [
{
"year": "2021",
"month_name": "August",
"amount": 33114.46
},
{
"year": "2021",
"month_name": "September",
"amount": 33120.1
},
{
"year": "2021",
"month_name": "October",
"amount": 33053.01
},
{
"year": "2021",
"month_name": "November",
"amount": 33030.43
},
{
"year": "2021",
"month_name": "December",
"amount": 33100.01
},
{
"year": "2022",
"month_name": "February",
"amount": 33000.39
},
{
"year": "2022",
"month_name": "March",
"amount": 66000.03
},
{
"year": "2022",
"month_name": "May",
"amount": 33000.01
},
{
"year": "2022",
"month_name": "June",
"amount": 67800
}
],
"validCredit": 365218,
"periodInStatement": "August - July",
"yearInStatement": "2021, 2022",
"firstDateInStatement": "2021-08-11",
"lastDateInStatement": "2022-07-03",
"closingBalance": 0.66
},
"incomeAnalysis": {
"salaryTransactions": [],
"averagePredictedSalary": 0,
"isSalaryEarner": "No",
"expectedSalaryPaymentDay": null,
"frequencyOfSalaryPayments": null,
"lastDateOfSalaryPayment": null,
"numberOfSalaryPayments": 0,
"hasOtherIncome": "Yes",
"otherIncomeTransactions": [
{
"date": "2021-08-11 23:00:00",
"description": "r 528454979 nysc state overhead cbn 528644412 528644548 n e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2021-09-30 23:00:00",
"description": "r 550550670 fgn feder sept2021allowforby 21b 1199 cbn 98100 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2021-10-31 23:00:00",
"description": "r 567816329 fgn feder laoct2021nra cbn 567820009 567820200 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2021-11-29 23:00:00",
"description": "r 582609618 la nov 2021 account transaction",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2021-12-21 23:00:00",
"description": "r 591501016 fgn feder ladec2021nra cbn 591440529 591440588 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2022-02-02 23:00:00",
"description": "r 612675569 fgn feder lajan2022nra cbn 612704173 612704251 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2022-03-03 23:00:00",
"description": "r 627184241 fgn feder lafeb2022nra cbn 627432670 627432964 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2022-03-31 23:00:00",
"description": "r 640647735 fgn feder lamarch2022nra cbn 640750873 6407511 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2022-05-30 23:00:00",
"description": "r 663852384 fgn feder lamay2022nra cbn 663871559 663871793 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2022-06-30 23:00:00",
"description": "r 676436160 fgn feder lajune2022nra cbn 676536723 67653703 e transfer",
"amount": 33000,
"month-name": null,
"year": null
},
{
"date": "2022-06-30 23:00:00",
"description": "r 676200225 fgn feder lajune2022 cbn 676536723 676537032 e transfer",
"amount": 34800,
"month-name": null,
"year": null
}
],
"averageOtherIncome": 33163.64,
"numberOfOtherIncomePayments": 11,
"netAverageMonthlyEarning": 9,
"lowestSalary": 0,
"mostRecentSalary": null
},
"confidenceOnParsing": 1
}