Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Current »

Try It Out Yourself

To try out our API and see a live example, visit our API Reference Test Page.

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

Method: POST

Authentication:Bearer <Token>

Content Type:Application/json

Sample Request

{
  "customer": {
    "id": "ckq9ehqmv000001me62y85j1u",
    "email": "johndoe@company.com",
    "lastName": "Doe",
    "firstName": "John",
    "phone": "8101010110"
  },
  "bankStatement": {
    "type": "mono",
    "content": {
      "paging": {
        "total": 190,
        "page": 2,
        "previous": "https://api.withmono.com/accounts/:id/transactions?page=2",
        "next": "https://api.withmono.com/accounts/:id/transactions?page=3"
      },
   "data":[
      {
         "_id":"61d38401540f62448a67b18f",
         "date":"2022-01-01T00:00:00.000Z",
         "type":"debit",
         "amount":5000,
         "balance":7441442,
         "currency":"NGN",
         "narration":"FGN STAMP DUTY/S10761279 ON 31-DEC-21 FOR ACCOUNT"
      },
      {
         "_id":"61d38401540f62448a67b190",
         "date":"2022-01-01T00:00:00.000Z",
         "type":"debit",
         "amount":5000,
         "balance":7446442,
         "currency":"NGN",
         "narration":"FGN STAMP DUTY/S10754935 ON 31-DEC-21 FOR ACCOUNT"
      },
   ],
   "meta":{
      "count":186
   }

    }
  }
}

Sample Response

{
    "status": "success",
    "data": {
        "country": "Nigeria",
        "currency": "NGN",
        "behaviouralAnalysis": {
            "accountSweep": "No",
            "gamblingRate": 0,
            "inflowOutflowRate": "Positive Cash Flow",
            "loanAmount": 0,
            "loanInflowRate": 0,
            "loanRepaymentInflowRate": 0,
            "loanRepayments": 0,
            "lateLoanRepayments": 0,
            "returnedCheque": 0,
            "topIncomingTransferAccount": "John Ol",
            "topTransferRecipientAccount": "Be Refun"
        },
        "cashFlowAnalysis": {
            "accountActivity": 0.27,
            "averageBalance": 94077.86,
            "creditCount": 87,
            "debitCount": 99,
            "averageCredits": 16868.635402298853,
            "averageDebits": 14182.844444444445,
            "openingBalance": 10944.78,
            "closingBalance": 89214.43,
            "firstDay": "2021-07-04",
            "lastDay": "2022-01-01",
            "monthPeriod": "July - January",
            "netAverageMonthlyEarnings": -585.9400000000023,
            "noOfTransactingMonths": 7,
            "totalCreditTurnover": 1467571.28,
            "totalDebitTurnover": 1404101.6,
            "harmonicMeanCR": 7.29,
            "harmonicMeanDR": 100.78,
            "yearInStatement": "2022,2021",
            "maxEmiEligibility": 886,
            "affordability": 44009.27,
            "emiConfidenceScore": 0.06,
            "totalMonthlyCredit": [
                {
                    "month": "2021-12",
                    "amount": 440934.28
                },
                {
                    "month": "2021-11",
                    "amount": 215030
                },
                {
                    "month": "2021-10",
                    "amount": 250607
                },
                {
                    "month": "2021-09",
                    "amount": 161000
                },
                {
                    "month": "2021-08",
                    "amount": 200000
                },
                {
                    "month": "2021-07",
                    "amount": 200000
                }
            ],
            "totalMonthlyDebit": [
                {
                    "month": "2021-09",
                    "amount": 154397.92
                },
                {
                    "month": "2021-08",
                    "amount": 359974.74
                },
                {
                    "month": "2021-07",
                    "amount": 16442.27
                },
                {
                    "month": "2022-01",
                    "amount": 24326.87
                },
                {
                    "month": "2021-12",
                    "amount": 401681.76
                },
                {
                    "month": "2021-11",
                    "amount": 308156.85
                },
                {
                    "month": "2021-10",
                    "amount": 139121.19
                }
            ],
            "averageMonthlyCredit": [
                {
                    "month": "2021-12",
                    "amount": 5879.12
                },
                {
                    "month": "2021-11",
                    "amount": 71676.67
                },
                {
                    "month": "2021-10",
                    "amount": 41767.83
                },
                {
                    "month": "2021-09",
                    "amount": 161000
                },
                {
                    "month": "2021-08",
                    "amount": 200000
                },
                {
                    "month": "2021-07",
                    "amount": 200000
                }
            ],
            "averageMonthlyDebit": [
                {
                    "month": "2021-09",
                    "amount": 12866.49
                },
                {
                    "month": "2021-08",
                    "amount": 16362.49
                },
                {
                    "month": "2021-07",
                    "amount": 2348.9
                },
                {
                    "month": "2022-01",
                    "amount": 6081.72
                },
                {
                    "month": "2021-12",
                    "amount": 22315.65
                },
                {
                    "month": "2021-11",
                    "amount": 16218.78
                },
                {
                    "month": "2021-10",
                    "amount": 8183.6
                }
            ]
        },
        "incomeAnalysis": {
            "salaryEarner": "Yes",
            "pensioner": "No",
            "averagePension": 0,
            "medianIncome": 200000,
            "averageOtherIncome": 0,
            "expectedSalaryDay": 31,
            "lastSalaryDate": "2021-12-31",
            "averageSalary": 200000,
            "dsr": 0,
            "confidenceIntervalonSalaryDetection": 1,
            "salaryFrequency": "1",
            "numberSalaryPayments": 3,
            "salaryRecency": 874,
            "numberSalaryInLast3Months": 0,
            "numberSalaryInLast4Months": 0,
            "numberOtherIncomePayments": 0,
            "gigWorker": "No",
            "microSME": "No"
        },
        "spendAnalysis": {
            "averageRecurringExpense": 8428.57,
            "hasRecurringExpense": "Yes",
            "averageMonthlyExpenses": 200585.94,
            "expenseChannels": [
                {
                    "key": "atmSpend",
                    "value": 0
                },
                {
                    "key": "webSpend",
                    "value": 0
                },
                {
                    "key": "posSpend",
                    "value": 50400
                },
                {
                    "key": "ussdTransactions",
                    "value": 1244.75
                },
                {
                    "key": "mobileSpend",
                    "value": 192855.84
                },
                {
                    "key": "spendOnTransfers",
                    "value": 1244.75
                },
                {
                    "key": "internationalTransactionsSpend",
                    "value": 0
                }
            ],
            "expenseCategories": [
                {
                    "key": "bills",
                    "value": 53.75
                },
                {
                    "key": "entertainment",
                    "value": 0
                },
                {
                    "key": "savingsAndInvestments",
                    "value": 0
                },
                {
                    "key": "gambling",
                    "value": 0
                },
                {
                    "key": "airtime",
                    "value": 104.67
                },
                {
                    "key": "bankCharges",
                    "value": 262.56
                },
                {
                    "key": "chequeWithdrawal",
                    "value": 0
                },
                {
                    "key": "cashWithdrawal",
                    "value": 0
                },
                {
                    "key": "shopping",
                    "value": 0
                },
                {
                    "key": "eatingOut",
                    "value": 29626.63
                }
            ]
        },
        "transactionPatternAnalysis": {
            "MAWWZeroBalanceInAccount": {
                "month": null,
                "week_of_month": 0
            },
            "NODWBalanceLess5000": 2,
            "NODWBalanceLess": {
                "amount": 5000,
                "count": 2
            },
            "highestMAWOCredit": {
                "month": "December",
                "week_of_month": 5
            },
            "highestMAWODebit": {
                "month": "December",
                "week_of_month": 5
            },
            "lastDateOfCredit": "2021-12-31",
            "lastDateOfDebit": "2022-01-01",
            "mostFrequentBalanceRange": "10000-100000",
            "mostFrequentTransactionRange": "<10000",
            "recurringExpense": [
                {
                    "amount": 14000,
                    "description": "MOB/UTU/9817215156/Fuel for the range"
                }
            ],
            "transactionsBetween100000And500000": 11,
            "transactionsBetween10000And100000": 40,
            "transactionsGreater500000": 0,
            "transactionsLess10000": 135,
            "transactionRanges": [
                {
                    "min": 10000,
                    "max": 100000,
                    "count": 40
                },
                {
                    "min": 100000,
                    "max": 500000,
                    "count": 11
                },
                {
                    "min": null,
                    "max": 10000,
                    "count": 135
                },
                {
                    "min": 500000,
                    "max": null,
                    "count": 0
                }
            ]
        },
        "statementAccuracy": {
            "checks": {
                "balanceAccuracy": false,
                "airtimeOutlier": false,
                "transactionFeeOutlier": true
            }
        },
        "breakdowns": [
            {
                "name": "salary",
                "values": [
                    {
                        "date": "2021-08",
                        "amount": 200000
                    },
                    {
                        "date": "2021-10",
                        "amount": 200000
                    },
                    {
                        "date": "2021-12",
                        "amount": 200000
                    }
                ]
            },
            {
                "name": "otherIncome",
                "values": []
            },
            {
                "name": "individualSalary",
                "values": [
                    {
                        "date": "2021-08-02",
                        "amount": 200000
                    },
                    {
                        "date": "2021-10-31",
                        "amount": 200000
                    },
                    {
                        "date": "2021-12-31",
                        "amount": 200000
                    }
                ]
            },
            {
                "name": "loan",
                "values": []
            },
            {
                "name": "loanRepayment",
                "values": []
            }
        ],
        "id": "f5a97364678bfa053e0ef5dbe92278057917e4987cb4b1f1aa58e54db97beef2243ca8cd39a38e8ca4391e6f588cce1647e17dc1bc4b0686e30f90087e685375"
    }
}
  • No labels