Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Endpoint: https://api.indicina.co/api/v3/client/bsp

Method: POST

Authentication:Bearer <Token>

Content Type:Application/json

Sample Request

Code Block
{
  "customer": {
    "id": "13.10",
    "email": "johndoe@company.com",
    "lastName": "Doe",
    "firstName": "John",
    "phone": "8101010110"
  },
  "bankStatement": {
    "type": "mbs",
    "content": {
      "status": "00",
      "message": "Successful",
      "result": "{ \"status\": \"success\",\"Name\": \"John Doe\",\"Nuban\": \"0825902262\",\"AccountCategory\": \"CRYPTRADE\",\"AccountType\": \"SAVINGS\",\"TicketNo\": \"1497232-6\",\"AvailableBal\": \"14007.6300\",\"BookBal\": \"14057.6300\",\"TotalCredit\": \"156298\",\"TotalDebit\": \"242349.42\",\"Tenor\": \"0\",\"Period\": \"5/1/2021 12:00:00 AM to 5/30/2021 12:00:00 AM\",\"Currency\": \"NGN\",\"Address\": \"NO5 XYZ Estate, ADMOLL, Lagos State LAGOS NG\",\"Applicants\": \"Admoll Dummy\",\"Signatories\": [{\"Name\": \"N/A\",\"BVN\":\"N/A\"}],\"Details\": [{\"PTransactionDate\":\"5/1/2021\",\"PValueDate\":\"4/30/2021\",\"PNarration\":\"OPB Opening Balance\",\"PCredit\":\"0\",\"PDebit\":\"0\",\"PBalance\":\"100109.05\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"4/30/2021\",\"PNarration\":\"ADMGENUS TRF/Okay/FRM John Doe TO Doe John- 058\",\"PCredit\":\"0\",\"PDebit\":\"2510.75\",\"PBalance\":\"97598.30\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"4/30/2021\",\"PNarration\":\"ADMGENUS TRF/April workers due/FRM John Doe TO ADMG CHAPEL OF LOVE PARISH- 058\",\"PCredit\":\"0\",\"PDebit\":\"3010.75\",\"PBalance\":\"94587.55\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"4/30/2021\",\"PNarration\":\"ADMGENUS TRF/Nepa money/FRM John Doe TO Admoll Wick - 035\",\"PCredit\":\"0\",\"PDebit\":\"4010.75\",\"PBalance\":\"90576.80\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"4/30/2021\",\"PNarration\":\"ADMGENUS TRF/Manage the 3k/FRM John Doe TO Mary Doe robinson\",\"PCredit\":\"0\",\"PDebit\":\"23000\",\"PBalance\":\"67576.80\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"4/30/2021\",\"PNarration\":\"ADMGENUS TRF/Thank you/FRM John Doe TO Admoll Wic - 035\",\"PCredit\":\"0\",\"PDebit\":\"22526.88\",\"PBalance\":\"45049.92\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"4/30/2021\",\"PNarration\":\"ADMGENUS TRF/Admoll Tithe/FRM John Doe TO CHRISTIAN CHURCH OF ADMG - 070\",\"PCredit\":\"0\",\"PDebit\":\"20026.88\",\"PBalance\":\"25023.04\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"5/3/2021\",\"PNarration\":\"ADMGENUS TRF/John/FRM John Doe TO John Wick - 058\",\"PCredit\":\"0\",\"PDebit\":\"2510.75\",\"PBalance\":\"22512.29\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"5/3/2021\",\"PNarration\":\"ADMGENUS TRF/Thanks/FRM John Doe TO Admoll Ese - 221\",\"PCredit\":\"0\",\"PDebit\":\"12026.88\",\"PBalance\":\"10485.41\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"5/3/2021\",\"PNarration\":\"ADMGENUS TRF/Thanks/FRM John Doe TO Admoll Ese- 011\",\"PCredit\":\"0\",\"PDebit\":\"5010.75\",\"PBalance\":\"5474.66\"},{\"PTransactionDate\":\"5/3/2021\",\"PValueDate\":\"5/3/2021\",\"PNarration\":\"ADMGENUS AIRTIME/ MTN/08100900000\",\"PCredit\":\"0\",\"PDebit\":\"300\",\"PBalance\":\"5174.66\"},{\"PTransactionDate\":\"5/4/2021\",\"PValueDate\":\"5/3/2021\",\"PNarration\":\"ADMOLLDEV ADMOLL DUMMY/SENT FROM KUDA\",\"PCredit\":\"2000\",\"PDebit\":\"0\",\"PBalance\":\"7174.66\"},{\"PTransactionDate\":\"5/4/2021\",\"PValueDate\":\"5/3/2021\",\"PNarration\":\"ADMOLLDEV CURRENTIC INTERNATIONAL LTD/R\",\"PCredit\":\"10000\",\"PDebit\":\"0\",\"PBalance\":\"17174.66\"},{\"PTransactionDate\":\"5/5/2021\",\"PValueDate\":\"5/5/2021\",\"PNarration\":\"ADMGENUS TRF/Ok/FRM John Doe TO Doe John- 058\",\"PCredit\":\"0\",\"PDebit\":\"15026.88\",\"PBalance\":\"2147.78\"},{\"PTransactionDate\":\"5/5/2021\",\"PValueDate\":\"5/5/2021\",\"PNarration\":\"MOLLSWITCH FGN ELECTRONIC MONEY TRANSFER LEVY\",\"PCredit\":\"0\",\"PDebit\":\"50\",\"PBalance\":\"2097.78\"},{\"PTransactionDate\":\"5/6/2021\",\"PValueDate\":\"5/5/2021\",\"PNarration\":\"ADMGENUS AIRTIME/ MTN/08100900000\",\"PCredit\":\"0\",\"PDebit\":\"200\",\"PBalance\":\"1897.78\"},{\"PTransactionDate\":\"5/6/2021\",\"PValueDate\":\"5/5/2021\",\"PNarration\":\"ADMGENUS AIRTIME/ MTN/08100900000\",\"PCredit\":\"0\",\"PDebit\":\"200\",\"PBalance\":\"1697.78\"},{\"PTransactionDate\":\"5/6/2021\",\"PValueDate\":\"5/5/2021\",\"PNarration\":\"ADMGENUS RVSL_AIRTIME/ MTN/08100900000\",\"PCredit\":\"200\",\"PDebit\":\"0\",\"PBalance\":\"1897.78\"},{\"PTransactionDate\":\"5/7/2021\",\"PValueDate\":\"5/6/2021\",\"PNarration\":\"ADMOLLDEV ADMOLL DUMMY/SENT FROM KUDA\",\"PCredit\":\"2000\",\"PDebit\":\"0\",\"PBalance\":\"3897.78\"},{\"PTransactionDate\":\"5/10/2021\",\"PValueDate\":\"5/10/2021\",\"PNarration\":\"ADMGENUS TRF/Thank you sir/FRM John Doe TO JOHN WICK\",\"PCredit\":\"0\",\"PDebit\":\"3000\",\"PBalance\":\"897.78\"},{\"PTransactionDate\":\"5/10/2021\",\"PValueDate\":\"5/8/2021\",\"PNarration\":\"ADMOLLDEV ADMOLL DUMMY/Admoll\",\"PCredit\":\"3000\",\"PDebit\":\"0\",\"PBalance\":\"3897.78\"},{\"PTransactionDate\":\"5/11/2021\",\"PValueDate\":\"5/10/2021\",\"PNarration\":\"ADMGENUS TRF/Last week midweek offering/FRM John Doe TO Admoll Ese- 011\",\"PCredit\":\"0\",\"PDebit\":\"3860.75\",\"PBalance\":\"37.03\"},{\"PTransactionDate\":\"5/11/2021\",\"PValueDate\":\"5/11/2021\",\"PNarration\":\"ADMOLLDEV ADMG CHAPEL OF LOVE PARISH/NIP TRF FROM ADMG CHAPEL OF LOVE PARISH IFO John Doe\",\"PCredit\":\"25000\",\"PDebit\":\"0\",\"PBalance\":\"25037.03\"},{\"PTransactionDate\":\"5/11/2021\",\"PValueDate\":\"5/11/2021\",\"PNarration\":\"USSDUSER USSD/ADMOLL-WILLY/08XXXX5322/John Doe\",\"PCredit\":\"1000\",\"PDebit\":\"0\",\"PBalance\":\"26037.03\"},{\"PTransactionDate\":\"5/11/2021\",\"PValueDate\":\"5/11/2021\",\"PNarration\":\"NEXTGENUSR TRF/Babe/FRM John  Doe TO Mary Doe\",\"PCredit\":\"0\",\"PDebit\":\"10000\",\"PBalance\":\"16037.03\"},{\"PTransactionDate\":\"5/11/2021\",\"PValueDate\":\"5/11/2021\",\"PNarration\":\"ADMGENUS TRF/Thanks/FRM John Doe TO JOHN MARY- 058\",\"PCredit\":\"0\",\"PDebit\":\"10026.88\",\"PBalance\":\"6010.15\"},{\"PTransactionDate\":\"5/16/2021\",\"PValueDate\":\"5/15/2021\",\"PNarration\":\"ADMGENUS AIRTIME/ MTN/08100900000\",\"PCredit\":\"0\",\"PDebit\":\"300\",\"PBalance\":\"5710.15\"},{\"PTransactionDate\":\"5/16/2021\",\"PValueDate\":\"5/16/2021\",\"PNarration\":\"ADMGENUS TRF/Ok/FRM John Doe TO Admoll Ese- 011\",\"PCredit\":\"0\",\"PDebit\":\"3010.75\",\"PBalance\":\"2699.40\"},{\"PTransactionDate\":\"5/16/2021\",\"PValueDate\":\"5/16/2021\",\"PNarration\":\"ADMGENUS TRF//FRM John Doe TO Mary Doe\",\"PCredit\":\"0\",\"PDebit\":\"2000\",\"PBalance\":\"699.40\"},{\"PTransactionDate\":\"5/17/2021\",\"PValueDate\":\"5/17/2021\",\"PNarration\":\"ADMGENUS AIRTIME/ MTN/08100900000\",\"PCredit\":\"0\",\"PDebit\":\"300\",\"PBalance\":\"399.40\"},{\"PTransactionDate\":\"5/21/2021\",\"PValueDate\":\"5/21/2021\",\"PNarration\":\"USSDUSER 901Airtime- 234810090000 USSDALUSSD132660520102655092\",\"PCredit\":\"0\",\"PDebit\":\"300\",\"PBalance\":\"99.40\"},{\"PTransactionDate\":\"5/22/2021\",\"PValueDate\":\"5/22/2021\",\"PNarration\":\"ADMOLLDEV ADMOLL OMG/via GTWORLD\",\"PCredit\":\"5000\",\"PDebit\":\"0\",\"PBalance\":\"5099.40\"},{\"PTransactionDate\":\"5/22/2021\",\"PValueDate\":\"5/22/2021\",\"PNarration\":\"ADMGENUS TRF/Materials payment/FRM John Doe TO OMG WICK\",\"PCredit\":\"0\",\"PDebit\":\"3500\",\"PBalance\":\"1599.40\"},{\"PTransactionDate\":\"5/22/2021\",\"PValueDate\":\"5/22/2021\",\"PNarration\":\"ADMGENUS TRF/Hair/FRM John Doe TO Mary Doe- 232\",\"PCredit\":\"0\",\"PDebit\":\"1010.75\",\"PBalance\":\"588.65\"},{\"PTransactionDate\":\"5/23/2021\",\"PValueDate\":\"5/23/2021\",\"PNarration\":\"ADMOLLDEV ADMOLL BENTEN/FBNMOBILE:John Doe/BENTEN\",\"PCredit\":\"5000\",\"PDebit\":\"0\",\"PBalance\":\"5588.65\"},{\"PTransactionDate\":\"5/23/2021\",\"PValueDate\":\"5/23/2021\",\"PNarration\":\"ADMGENUS AIRTIME/ MTN/08100900000\",\"PCredit\":\"0\",\"PDebit\":\"100\",\"PBalance\":\"5488.65\"},{\"PTransactionDate\":\"5/23/2021\",\"PValueDate\":\"5/23/2021\",\"PNarration\":\"ADMOLLDEV ADMOLL BENJ/ATM NIP @ 10331267/0825902262 Access\",\"PCredit\":\"3000\",\"PDebit\":\"0\",\"PBalance\":\"8488.65\"},{\"PTransactionDate\":\"5/25/2021\",\"PValueDate\":\"5/25/2021\",\"PNarration\":\"ADMGENUS TRF/Hi/FRM John Doe TO JOHN WICK- 033\",\"PCredit\":\"0\",\"PDebit\":\"2010.75\",\"PBalance\":\"6477.90\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMGENUS AIRTIME/ MTN/08100900000\",\"PCredit\":\"0\",\"PDebit\":\"400\",\"PBalance\":\"6077.90\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMOLLDEV ADMOLL TECHNOLOGIES ADS TECHNOLOGIES LIMITED/637579813500688913-21 Allowance and commission 2021 113846759\",\"PCredit\":\"100098\",\"PDebit\":\"0\",\"PBalance\":\"106175.90\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMGENUS TRF/Thursday and Today/FRM John Doe TO Admoll Ese- 011\",\"PCredit\":\"0\",\"PDebit\":\"8026.88\",\"PBalance\":\"98149.02\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMGENUS TRF/Thanks/FRM John Doe TO ADMOLL LIAM- 221\",\"PCredit\":\"0\",\"PDebit\":\"30026.88\",\"PBalance\":\"68122.14\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMGENUS TRF/I love you/FRM John Doe TO Mary Doe\",\"PCredit\":\"0\",\"PDebit\":\"7000\",\"PBalance\":\"61122.14\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMGENUS TRF/May due/FRM John Doe TO ADMG CHAPEL OF LOVE PARISH- 058\",\"PCredit\":\"0\",\"PDebit\":\"3010.75\",\"PBalance\":\"58111.39\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMGENUS TRF/Admoll tithe/FRM John Doe TO ADMG CHRISTIAN CHURCH OF GOD CHAPEL OF LOVE PARISH- 070\",\"PCredit\":\"0\",\"PDebit\":\"20026.88\",\"PBalance\":\"38084.51\"},{\"PTransactionDate\":\"5/30/2021\",\"PValueDate\":\"5/30/2021\",\"PNarration\":\"ADMGENUS TRF/Thanks/FRM John Doe TO Admoll Wick Doe- 035\",\"PCredit\":\"0\",\"PDebit\":\"24026.88\",\"PBalance\":\"14057.63\"}]}"
    }
  }
}

Sample Response

Code Block
{
    "status": "success",
    "data": {
        "country": "Nigeria",
        "currency": "NGN",
        "behaviouralAnalysis": {
            "accountSweep": "No",
            "gamblingRate": 0,
            "inflowOutflowRate": "Negative Cash Flow",
            "loanAmount": 0,
            "loanInflowRate": 0,
            "loanRepaymentInflowRate": 0,
            "loanRepayments": 0,
            "lateLoanRepayments": 0,
            "returnedCheque": 0,
            "topIncomingTransferAccount": "Kuda",
            "topTransferRecipientAccount": "Mary Doe"
        },
        "cashFlowAnalysis": {
            "accountActivity": 0.52,
            "averageBalance": 23840.87,
            "creditCount": 11,
            "debitCount": 34,
            "averageCredits": 14208.90909090909,
            "averageDebits": 7127.9241176470605,
            "openingBalance": 100109.05,
            "closingBalance": 14057.63,
            "firstDay": "2021-05-03",
            "lastDay": "2021-05-30",
            "monthPeriod": "May - May",
            "netAverageMonthlyEarnings": -242349.42,
            "noOfTransactingMonths": 1,
            "totalCreditTurnover": 156298,
            "totalDebitTurnover": 242349.42000000004,
            "harmonicMeanCR": 1338.74,
            "harmonicMeanDR": 549.99,
            "yearInStatement": "2021",
            "maxEmiEligibility": 2337,
            "affordability": 0,
            "emiConfidenceScore": 0.15,
            "totalMonthlyCredit": [
                {
                    "month": "2021-05",
                    "amount": 156298
                }
            ],
            "totalMonthlyDebit": [
                {
                    "month": "2021-05",
                    "amount": 242349.42
                }
            ],
            "averageMonthlyCredit": [
                {
                    "month": "2021-05",
                    "amount": 14208.91
                }
            ],
            "averageMonthlyDebit": [
                {
                    "month": "2021-05",
                    "amount": 7127.92
                }
            ]
        },
        "incomeAnalysis": {
            "salaryEarner": "No",
            "pensioner": "No",
            "averagePension": 0,
            "medianIncome": 0,
            "averageOtherIncome": 0,
            "expectedSalaryDay": 0,
            "lastSalaryDate": null,
            "averageSalary": 0,
            "dsr": 0,
            "confidenceIntervalonSalaryDetection": 0,
            "salaryFrequency": null,
            "numberSalaryPayments": 0,
            "salaryRecency": null,
            "numberSalaryInLast3Months": 0,
            "numberSalaryInLast4Months": 0,
            "numberOtherIncomePayments": 0,
            "gigWorker": "No",
            "microSME": "No"
        },
        "spendAnalysis": {
            "averageRecurringExpense": 203672.54,
            "hasRecurringExpense": "Yes",
            "averageMonthlyExpenses": 242349.42,
            "expenseChannels": [
                {
                    "key": "atmSpend",
                    "value": 0
                },
                {
                    "key": "webSpend",
                    "value": 0
                },
                {
                    "key": "posSpend",
                    "value": 0
                },
                {
                    "key": "ussdTransactions",
                    "value": 300
                },
                {
                    "key": "mobileSpend",
                    "value": 0
                },
                {
                    "key": "spendOnTransfers",
                    "value": 240249.42
                },
                {
                    "key": "internationalTransactionsSpend",
                    "value": 0
                }
            ],
            "expenseCategories": [
                {
                    "key": "bills",
                    "value": 0
                },
                {
                    "key": "entertainment",
                    "value": 0
                },
                {
                    "key": "savingsAndInvestments",
                    "value": 0
                },
                {
                    "key": "gambling",
                    "value": 0
                },
                {
                    "key": "airtime",
                    "value": 2100
                },
                {
                    "key": "bankCharges",
                    "value": 50
                },
                {
                    "key": "chequeWithdrawal",
                    "value": 0
                },
                {
                    "key": "cashWithdrawal",
                    "value": 0
                },
                {
                    "key": "shopping",
                    "value": 0
                },
                {
                    "key": "eatingOut",
                    "value": 0
                }
            ]
        },
        "transactionPatternAnalysis": {
            "MAWWZeroBalanceInAccount": {
                "month": null,
                "week_of_month": 0
            },
            "NODWBalanceLess5000": 9,
            "NODWBalanceLess": {
                "amount": 5000,
                "count": 9
            },
            "highestMAWOCredit": {
                "month": "May",
                "week_of_month": 5
            },
            "highestMAWODebit": {
                "month": "May",
                "week_of_month": 5
            },
            "lastDateOfCredit": "2021-05-30",
            "lastDateOfDebit": "2021-05-30",
            "mostFrequentBalanceRange": "<10000",
            "mostFrequentTransactionRange": "<10000",
            "recurringExpense": [
                {
                    "amount": 5010.75,
                    "description": "ADMGENUS TRF/Thanks/FRM John Doe TO Admoll Ese- 011"
                },
                {
                    "amount": 2510.75,
                    "description": "ADMGENUS TRF/Okay/FRM John Doe TO Doe John- 058"
                },
                {
                    "amount": 4010.75,
                    "description": "ADMGENUS TRF/Nepa money/FRM John Doe TO Admoll Wick - 035"
                }
            ],
            "transactionsBetween100000And500000": 1,
            "transactionsBetween10000And100000": 12,
            "transactionsGreater500000": 0,
            "transactionsLess10000": 32,
            "transactionRanges": [
                {
                    "min": 10000,
                    "max": 100000,
                    "count": 12
                },
                {
                    "min": 100000,
                    "max": 500000,
                    "count": 1
                },
                {
                    "min": null,
                    "max": 10000,
                    "count": 32
                },
                {
                    "min": 500000,
                    "max": null,
                    "count": 0
                }
            ]
        },
        "statementAccuracy": {
            "checks": {
                "balanceAccuracy": true,
                "airtimeOutlier": false,
                "transactionFeeOutlier": false
            }
        },
        "breakdowns": [
            {
                "name": "salary",
                "values": []
            },
            {
                "name": "otherIncome",
                "values": []
            },
            {
                "name": "individualSalary",
                "values": []
            },
            {
                "name": "loan",
                "values": []
            },
            {
                "name": "loanRepayment",
                "values": []
            }
        ],
        "id": "2ea90cc9ddc9274af7304065ae332a306561338f5fe7a528424a7346e2766cda3818824a0789a31f4255945af9e23661fc6e35d68248a66eddf46a71a33a8265"
    }
}