⚙️
Akiba API Docs
  • 🚦Getting Started
    • 👋Welcome!
    • 🔐Authentication
    • 🤓Make your first API call
  • 🚀PRODUCTS
    • 🏗️Product Guideline
      • Platform integration
        • Origination widget
      • Developer integration
        • Verification
        • Risk Analysis
    • 🎓Use cases
  • 💡API Documentation
    • 👩‍💻API reference
      • Compliance Verification
        • Consumer Experian Report
        • AML & PEP
        • Search Phone Number
        • Transunion Verification
        • Transunion Credit Report
        • Company Credit Report
        • Companyreporttaskid
        • Search Companies
        • Business Details
        • Consumer Trace
        • Search Director
        • Bank Verification
        • Express Credit Score
        • ID Photo Verification
        • Real-Time ID Verification
        • ID Verification
      • Financial Risk Analysis
        • Get Sub-Account Transactions
        • Delete Account
        • Get Linked Account
        • Get Linked Accounts
        • Account Details
        • Get Transactions
        • Expenses
        • Revenue
        • Cashflow
        • Insights
        • Score
        • Scores
        • Get Pre-signed URL
        • Update User Details
        • Get User Account By ID
        • Create User
      • Enterprise (CIPC)
        • Office Addresses
        • E-filing History
        • Director Verification
        • Company Directors
        • Director Profile
        • Basic Enterprise information
        • Company Profile
      • Authorization
        • Whoami
        • Revoke
      • Sandbox
        • V1
          • Get Webhook Details
          • Update Webhook Details
          • Create Webhook Account
          • Sub-Account Transactions
          • Get All Linked Account Ids
          • Get Account Ids
          • Delink Account
          • Account Details
          • Link Account
          • Get Transactions
          • Get Expenses
          • Get Revenues
          • Get Cashflow
          • Financial Insights
          • Financial Score
          • Financial Scores
          • Get Pre-signed URL
          • Update User Details
          • Get User Details
          • Create User Account
    • 🤵Verification APIs
      • Comprehensive KYC
      • KYB
      • Bank Statement OCR
      • Selfie ID Verification
      • 👚Anti-Money Laundering (AML)
    • 🎯Risk Analysis
      • 👓Insights
        • Insyts user
        • Open Banking
        • Alternative Scores
        • Affordability Assessment
        • Default prediction
        • Spend analysis
      • ☢️Risk scoring
    • 🏦Bank Accounts
      • 🧯Actionable Insights
      • ⏰Lending recommendation
  • 💲Pricing
    • 🪙Credit Pricing
    • 🏃‍♀️Pre-paid API Credits
    • 🛂Subscription
  • Specification
  • About
  • Specification
Powered by GitBook
On this page
  • Spending analysis requires transaction data
  • Get Spending patterns
  • Shows spending trends of a customer
  1. API Documentation
  2. Risk Analysis
  3. Insights

Spend analysis

Spending analysis requires transaction data

For us to analyse spending patterns of your customer, we need transaction data from their bank account, wallet and or POS in the case of SMEs.

Example Transactions Object schema required:

{
  "transactions": [
    {
      "external_transaction_id": "958d14298-91ee-405d-89da-248c30eaf0e81-pending",
      "type": "debit",
      "amount": -255,
      "currency": "ZAR",
      "status": "Approved",
      "account_name": "Capitec-bank",
      "account_number": "123-123-123",
      "balance": {
        "amount": 12105,
        "currency": "ZAR",
        "type": "ClosingAvailable"
      },
      "date_time": 1774672448
    },
    {
      "external_transaction_id": "958d14298-91ee-405d-89da-248c30eaf0e81-pending",
      "type": "debit",
      "amount": -100,
      "currency": "ZAR",
      "status": "Approved",
      "account_name": "Capitec-bank",
      "account_number": "123-123-123",
      "balance": {
        "amount": 12005,
        "currency": "ZAR",
        "type": "ClosingAvailable"
      },
      "date_time": 1574672448
    }
    ]
}

Get Spending patterns

Shows spending trends of a customer

POST https://api.akibadigital.com/v1/spending

Headers

Name
Type
Description

Token*

String

Access auth Token

Content-Type*

String

application/json

Request Body

Name
Type
Description

customer_reference*

String

your custom reference of the customer i.e phone number

transactions*

Object

transaction object similar to example provided above

customer_type*

String

1 for individual and 2 for business

currency

String

{
  "income": {
    "currency": "ZAR",
    "number_of_salaries": "2",
    "possible_financial_distress_indicator": false,
    "out_of_work_benefit_indicator": false,
    "new_employer_indicator": false,
    "expected_salary": [
      {
        "amount": "12502.60",
        "expected_pay_date": "1608418799",
        "pay_frequency": "monthly"
      }
    ],
    "categories": [
      {
        "name": "Salary",
        "monthly_amounts": [
          {
            "amount": "12502.60",
            "year": "2021",
            "month": "3"
          }
        ]
      },
      {
        "name": "Other",
        "monthly_amounts": [
          {
            "amount": "2002.60",
            "year": "2021",
            "month": "3"
          }
        ]
      }
    ]
  },
  "spending": {
    "currency": "ZAR",
    "monthly_amounts": [
      {
        "percentage": "93%",
        "amount": "11309.43",
        "month": "3"
      }
    ],
    
  "spending_patterns": {
    "currency": "ZAR",
    
    "by_category": [
      {
        "category": "Groceries & Supplies",
        "min": "1845.03",
        "mean": "2008.32",
        "max": "2150.11",
        "frequency": "15.5",
        "recency": "3"
      },
      {
        "category": "Groceries & Supplies",
        "min": "1845.03",
        "mean": "2008.32",
        "max": "2150.11",
        "frequency": "15.5",
        "recency": "3"
      },
      {
        "category": "Groceries & Supplies",
        "min": "1845.03",
        "mean": "2008.32",
        "max": "2150.11",
        "frequency": "15.5",
        "recency": "3"
      }
    ]
  },
  "financial_markers": {
    
    "new_debt_indicator": false,
    "credit_repayments": {
      "rate_of_change": "0.66",
      "pred_next_month": "1022.35",
      "ratio_to_income": "0.17"
    },
    "currency": "ZAR",
    
    "negative_balance_ratio": 0.5,
    "debt_management_indicator": false,
    "debit_bank_transfer": {
      "rate_of_change": "0.66",
      "pred_next_month": "122.35",
      "ratio_to_income": "0.07"
    },
    "summary_averages": {
      "average_fixed_exp": 0.5,
      "average_flexible_exp": 0.5,
      "average_income": 0.5
    },
    "utility_payments": {
      
    "debits": {
      "rate_of_change": "0.66",
      "pred_next_month": "122.35",
      "ratio_to_income": "0.07"
    },
    "cash_withdrawals": {
      "rate_of_change": "0.66",
      "pred_next_month": "122.35",
      "ratio_to_income": "0.07"
    }
  }
}
{
    // Response
}
PreviousDefault predictionNextRisk scoring

Last updated 1 year ago

💡
🎯
👓