⚙️
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
  • Scoring requires transaction data
  • Upload customer transaction data for scoring
  • Returns risk score of your individual or business customer
  1. API Documentation
  2. Risk Analysis

Risk scoring

Calculates risk score and default score of an individual customer using transaction data

The risk score has been designed to measure the likelihood of a customer (individual or business) to default on credit. The underlying scorecard is built using statistical judgment model built from credit risk metrics, all of which are extracted from transaction data.

The payability score quantifies the near-term funds available to a customer. It quantifies the probability to determine a customer’s capacity to repay credit by analysing how likely a customer’s account balance will hit zero within 90 days, inferred from modelling a customer’s balance history.

For the best risk scoring results, insert at least 3 months of transaction history of your customer

Scoring requires transaction data

For us to calculate a risk score 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
    }
    ]
}

Upload customer transaction data for scoring

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

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

webhook_url

String

{
    "score": 0.2964672868854194,
    "income_volatility": 0.675, 
    "balance_variability": 0.123, 
    "payability_score": 0.814060422422,
    "confidence": 0.8730592042
}

Returns risk score of your individual or business customer

GET https://api.akibadigital.com/v1/scoring/{customer_id}/

Headers

Name
Type
Description

Token*

String

Content-Type*

String

application/json

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    "score": 0.2964672868854194,
    "income_volatility": 0.675, 
    "balance_variability": 0.123, 
    "payability_score": 0.814060422422,
    "confidence": 0.8730592042
}
{
    // Response
}

PreviousSpend analysisNextBank Accounts

Last updated 1 year ago

💡
🎯
☢️