Allows merchant to make informed decisions about pending loan applicants

📘

POST (LIVE)

{{URL}}/dikript/analytics/api/v1/analyse

📘

POST (TEST)

{{URL}}/dikript/test/api/v1/analyse

Request

VariableDescriptionRequired
statementNameName of statementYes
typeCONSUMER / BUSINESSNo
transactionsAt least 10 transactionsYes

{
	"statementName": "DemoStatement",
  "type":"BUSINESS",
	"transactions": [
		{
			"date": "2020-06-22",
			"description": "sms notification charge for 2020 ma y 14th 15th june - ngn",
			"balance": 247.42,
			"amount": 55.0,
			"type": "debit"
		}
	]
}

Header (LIVE)

KeyDescription
x-api-keyYour Secret Key

Header (TEST)

KeyDescription
x-api-keyYour Public Key

Response

{
    "status": true,
    "message": "Successful",
    "code": "200",
    "apiVersion": "v1",
    "transactionRef": "N202407051301381100",
    "data": {
        "key": 2,
        "status": "PROCESSED",
        "statementName": "DemoStatement",
        "fullName": null,
        "phoneNumber": null,
        "accountType": null,
        "accountBalance": null,
        "accountNumber": null,
        "accountName": null,
        "bankName": null,
        "spendAnalysis": {
            "averageMonthlyTotalExpenses": 299649.32,
            "totalRecurringExpense": 0.0,
            "totalExpenses": 2097545.22,
            "atmLocations": [
                "surulere"
            ],
            "mostFrequentSpendCategory": "transfer_transactions",
            "monthWithHighestSpend": "11/2020",
            "highestSpend": 636550.59,
            "mostFrequentExpense": "online gtbank plc bello muhyidde en garba onepay transfer bello m uhyiddeen garba gtbank plc",
            "mostFrequentExpenseAmount": 10000.0
        },
        "behaviouralAnalysis": {
            "monthToMonthInflowToOutflowRate": "Positive Cash Flow",
            "overallInflowToOutflowRate": "Positive Cash Flow",
            "totalLoanAmount": 0.0,
            "totalLoanRepaymentAmount": 0.0,
            "loanInflowRate": null,
            "loanRepaymentToInflowRate": 0.0,
            "gamblingRate": 0.0,
            "percentOfInflowIrregularity": 0.01,
            "averageMonthlyLoanAmount": 0.0,
            "averageMonthlyLoanRepaymentAmount": 0.0,
            "numberLoanTransactions": 0.0,
            "numberRepaymentTransactions": 0.0,
            "loanToInflowRate": 0.0,
            "accountSweep": "No",
            "numberOfBettingTransactions": 0.0
        },
        "cashFlowAnalysis": {
            "totalCreditTurnover": 2228623.3,
            "totalDebitTurnOver": 2101979.23,
            "averageMonthlyCredits": 371437.22,
            "averageMonthlyDebits": 350329.87,
            "averageWeeklyCredits": 89144.93,
            "averageWeeklyDebits": 80845.35,
            "averageMonthlyBalance": 240651.91,
            "averageWeeklyBalance": 272316.72,
            "numberOfTransactingMonths": 6.0,
            "validCredit": 2228022.57,
            "periodInStatement": "June - December",
            "yearInStatement": "2020",
            "firstDateInStatement": "2020-06-22",
            "lastDateInStatement": "2020-12-14",
            "closingBalance": 104944.61,
            "percentageOfExpenseOverInflow": 0.94
        },
        "incomeAnalysis": {
            "averagePredictedSalary": 226247.64,
            "isSalaryEarner": "Yes",
            "expectedSalaryPaymentDay": 25.0,
            "frequencyOfSalaryPayments": "1",
            "numberOfSalaryPayments": 6.0,
            "hasOtherIncome": "Yes",
            "averageOtherIncome": 278491.54,
            "numberOfOtherIncomePayments": 1.0,
            "netAverageMonthlyEarning": 205089.86,
            "lowestSalary": 223158.06,
            "lowestSalaryDate": "2020-06-26 00:00:00",
            "mostRecentSalary": "227354.12",
            "missingSalaryPayment": null,
            "totalCreditFromBusinessPayment": null,
            "percentageOfCreditFromBusinessPayment": null,
            "totalCreditFromBankWithdrawals": null,
            "percentageOfCreditFromBankWithdrawals": null,
            "totalCreditFromAgentDeposits": null,
            "percentageOfCreditFromAgentDeposits": null
        }
    },
    "error": null
}
{
    "status": false,
    "message": "Unsuccessful",
    "code": "400",
    "apiVersion": "v1",
    "transactionRef": "N202401101345487388",
    "data": "",
    "error": {
        "code": 400,
        "message": null
    }
}