Scoring Results

Get the credit scoring results of an uploaded Mpesa statement statement

Get Statement Scores

GET {{BASE_URL}}/api/v1/statement/mpesa/score?reference_id=:reference_id&file_json=:file_json

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

Query Parameters

Name	Type	Description
file_json*	String	Valuen should be jsonurl returned to the callback url
reference_id*	String	reference in statement upload response

Headers

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

200 Categories successfully retrieved.

{
    "status": 200,
    "message": "Customer Score result fetched successfully",
    "data": {
        "national_id": "32941218",
        "score_data": {
            "national_id": "32941218",
            "mpesa_default": null,
            "crb_score": null,
            "mpesa_crb": null,
            "average_score": null,
            "fundable_status": "fundable",
            "limit": "10000",
            "score": "528.607749227731",
            "score_cat": null,
            "borrowing_vs_income_ratio": "0.0",
            "borrowing_vs_income": "Good",
            "repayment_rate_ratio": "0.66",
            "repayment_rate": "Bad",
            "spending_rate_ratio": "1.0",
            "spending_rate": "Moderate",
            "pezesha_mpesa_credit_score": null,
            "pezesha_mpesa_crb_credit_score": null,
            "crb_mobile_loan_score": null,
            "pezesha_average_score": null
        },
        "created_at": "2023-06-20T17:20:00+00:00"
    }
}

404 Could not find a cake matching this query.

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