βš™οΈ
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
  1. API Documentation
  2. API reference
  3. Financial Risk Analysis

Insights

PreviousCashflowNextScore
πŸ’‘
πŸ‘©β€πŸ’»
post

Comprehensive user's financial insight function with various fields and breakdowns. A detailed and structured overview of the user's financial situation.

Authorizations
Body
clientIdstringOptional

Client ID

userIdstringOptional

User ID

providerAccountIdstringOptional

Provide account ID

consentbooleanOptional

Agree to Terms of Use agreement

Responses
200Success
application/json
post
POST /insyts/insights HTTP/1.1
Host: api.akibaone.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "clientId": "text",
  "userId": "text",
  "providerAccountId": "text",
  "consent": true
}
200Success
{
  "director_list": [
    {
      "identifier": 1,
      "first_names": "text",
      "surname": "text",
      "initials": "text",
      "director_status": "text",
      "role": "text",
      "member_size_interest": 1,
      "member_contribution": 1,
      "appointment_date": "text",
      "enterprise_details": [
        {
          "enterprise_number": "text",
          "enterprise_name": "text",
          "enterprise_type": "text",
          "enterprise_status": "text",
          "registration_date": "text"
        }
      ]
    }
  ]
}