Patascore APIs
  • Patascore
  • Authentication
  • Customer Operations
    • Register Customer
    • Fetch Customer
  • Verification & Credit Data Operations
    • Fetch Verification
    • Mobiloanscore (Sync)
    • Mobiloanscore (Async)
  • Business Verification
    • Business Verification
    • Fetch Results (Optional)
  • MPESA Operations
    • Upload Statement (Extraction)
    • Extraction Status
    • Scoring Results
  • Bank Operations
    • Upload Statement (Extraction)
    • Scoring Results
  • Transactions Operations
    • Submit Transactions
    • Fetch Score Results
  • Financial Education
    • Fetch Modules
    • Fetch Websocket Conversaction
    • Fetch Customer Session Summary
    • Fetch Customer Summary
    • Fetch Program Summary
    • Customer Subscription
      • Subscribe to Websocket
  • Billing Operations
    • Account Balance
    • Topups
    • Account Usage
Powered by GitBook
On this page

Was this helpful?

  1. MPESA Operations

Scoring Results

Get the credit scoring results of an uploaded Mpesa statement statement

Get Statement Scores

GET {{BASE_URL}}/api/v1/statements/mpesa/report?ref_id=:reference_id

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

Query Parameters

Name
Type
Description

ref_id*

String

reference id in statement upload response

Headers

Name
Type
Description

Authentication*

String

Authentication token to track who is making the requests.

{
    "status": 200,
    "message": "Mpesa statement score report fetched successfully",
    {
   "data": {
       {
           "national_id": 1001,
           "phone_number": "M12345",
           “other_details”: { ... },
           
            "statement_details": [
                    {
                        "transaction_id": "PLV6XV3WK2",
                        "transaction_type": "Customer Transfer to 0721***691 - LEON NYONGA ARIGI",
                        "received_amount": 575.65,
                        "sent_amount": 0,
                        "balance_then": 236363.31,
                        "transaction_datetime": "2024-09-28T00:00:00"
                    },
                    
                    {
                    "transaction_id": "PLV6XV3WK3",
                    "transaction_type": "Customer Transfer to 0721***691 - LEON NYONGA ARIGI",
                    "received_amount": 575.65,
                    "sent_amount": 0,
                    "balance_then": 1000.31,
                    "transaction_datetime": "2024-09-28T00:00:00"
                }
            ],
            
           "score_data": {
               "reason_code_1": "Low number of transactions",
               "reason_code_2": "Low frequency of transactions",
               "reason_code_3": "Customer inactive for a long period",
               "reason_code_4": "Low transaction volumes",
               "probability": "45.56",
               "grade": "GG",
               "credit_score": "412",
               "limit": "[4386.0, 6579.0]"
           },
           
          "received_amount_trend": {
               "2023-11-30": 603407.4,
               "2023-12-31": 858879.0
           },
           
           "sent_amount_trend": {
               "2023-11-30": 214903.6,
               "2023-12-31": 357154.7
           },
           
           "balance_amount_trend": {
               "2023-11-30": 25844.450764,
               "2023-12-31": 35800.46298
           },
           
           "received_amount_trend": {
               "2023-11-30": 603407.4,
               "2023-12-31": 858879.0
           },
           
           "sent_amount_trend": {
               "2023-11-30": 214903.6,
               "2023-12-31": 357154.7
           },
           
           "balance_amount_trend": {
               "2023-11-30": 25844.450764,
               "2023-12-31": 35800.46298
           }

        },
        "fraud_data": {
          "message": "successfully obtained IPRS data",
          "national_id": "550000055",
          "statement_name": [
            "JOHN",
            "ALPHA",
            "DOE"
          ],
          "customer_name": [
            "Peter",
            "Marangi"
          ],
          "similarity_score": 0,
          "verified_status": "no match"
        },
    }
  }
}
{
    "status": 400,
    "message": "Statment Not Found"
}

PreviousExtraction StatusNextBank Operations

Last updated 6 days ago

Was this helpful?