Scoring Results

Get the credit scoring results of an uploaded Mpesa statement statement

Get Statement Scores

GET {{BASE_URL}}/api/v1/statement/bank/score?reference_id=:reference_id

This endpoint allows you to get the credit scoring results of an mpesa statement

Query Parameters

Name	Type	Description
reference_id*	String	reference in statement upload response

Headers

Name	Type	Description
Authentication*	String	Authentication token to track who is making the requests.

200 Score successfully retrieved.

{
    "status": 200,
    "message": "Customer Score result fetched successfully",
    "data": {
        "national_id": "546444747",
        "score_data": {
            "national_id": "546444747",
            "first_transaction_date": "1970-01-01",
            "last_transaction_date": "1970-01-01",
            "bank_statement_days": "1",
            "bank_inactive_days": "19530",
            "bank_total_days": "1",
            "max_debit": "54323426.0",
            "mean_debit": "41461.216660935934",
            "debit_std": "1074036.1405303841",
            "debit_zscore": "0.03860318577404799",
            "total_debit": "988767094.9300001",
            "max_credit": "150000.0",
            "mean_credit": "722.1127956222743",
            "credit_std": "6099.837738852835",
            "credit_zscore": "0.11838229581465529",
            "total_credit": "17220945.95",
            "n_debit": "274",
            "n_credit": "172",
            "n_transactions": "446",
            "n_ratio": "1.5930232558139534",
            "avg_balance": "6536.168542435424",
            "balance_std": "22572.88905983832",
            "z_balance": "0.28955835139705594",
            "min_balance": "0.0",
            "max_balance": "204044.97",
            "debit_credit_ratio": "57.42",
            "z_received": "0.03860237640658617",
            "average_monthly_received": "988767095.0",
            "unemployment": "6.6",
            "inflation": "9.2",
            "fx": "129.8",
            "gas": "1.4",
            "food_inflation": "13.3",
            "bank_rate": "8.75",
            "Total": "0.660370272871831",
            "new_repeat": "new",
            "name": "ANTHONY MATHENGE",
            "gender": "Male",
            "location": "Nairobi",
            "dob": "1996-07-30",
            "age": "26",
            "score": "282.9648303963427",
            "average_score": "282.9648303963427",
            "default_probability": "0.546350388743985",
            "score_cat": "Fair",
            "prev_sme": "no",
            "fundable_status": "non_fundable",
            "min_limit": "0",
            "max_limit": "0",
            "limit": "0"
        },
        "created_at": "2023-06-21T11:10:13+00:00"
    }
}

404 Could not find a cake matching this query.

{
    "status": 400,
    "message": "Statment Not Found"
}