Gathr API Documentation
Log Support Ticket
  • ๐Ÿ‘‹Welcome
  • ๐ŸŽขGet Going
  • ๐Ÿ™‹โ€โ™€๏ธCustomers
    • Single Customer CRUD
      • โž•Create New Customer
      • ๐Ÿ”ŽFind a Single Customer
      • ๐Ÿ‘พGet Customer by Custom Property
      • โฌ†๏ธUpdate Customer
      • โŒDelete Customer
    • ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆGet All Customers
    • ๐Ÿ“šGet Module Status of Customer
  • ๐Ÿ’ผBureau Information
    • ๐Ÿ†”Customer ID Verification - HANIS
    • ๐ŸŽญCustomer ID Verification
    • ๐Ÿ’ณTU - Credit Report
    • โœด๏ธTU - Credit Report and Score
    • โœณ๏ธXDS - Customer Credit Report and Score
  • ๐Ÿ”ŽAnti Money Laundering Screening
    • ๐Ÿ›ก๏ธAML Details
  • ๐Ÿ’ธConsumer Affordability [v1]
    • ๐Ÿ’ฐAffordability Introduction and Use Case [live edit]
    • ๐Ÿ†•Transaction Categorisation
    • Single Bank Account CRUD
      • โž•Create New Bank Account
      • ๐Ÿ”ŽFind a Single BankAccount
      • โฌ†๏ธUpdate BankAccount Type
      • โŒDelete BankAccount
    • ๐Ÿ’ปOnline Login
      • ๐Ÿ”—GathrLink Testing Data
      • ๐ŸŒSync Online Banking Accounts
      • ๐Ÿ‘ฝVerify Online Banking Account
    • ๐Ÿ”Repeat Online Login
      • ๐Ÿ”‚Repeat BankAccount Online Login
      • โœ…Return BankAccount Login Transaction History
    • ๐Ÿ“คBank Statement Upload
      • ๐ŸŒ…Bank Statement Upload V1.0
      • โšกBank Statement Upload V1.1
        • ๐Ÿ–จ๏ธScanned Statements
      • ๐Ÿ”Upload Bankstatement for a Customer v1.1 (Bank Identification Service)
      • ๐ŸŸ Consumer Fraud Score
    • ๐Ÿ“ณUSSD Statement
      • ๐Ÿ“ณUSSD Statement Collection
      • ๐Ÿ‘€USSD Activity Log
    • ๐Ÿ”ขTransactions
      • โš–๏ธReturn all Transactions from a Bank Account
      • ๐ŸŸฉReturn a Single Transaction
      • ๐Ÿ’ฐReturn All Accounts of a Bank Account
    • ๐Ÿ“ŠReports
      • ๐Ÿ’ถSummary Plus
      • ๐Ÿ’ดSummary Report
      • ๐Ÿ“ŠMonthly
      • ๐Ÿ“‰Expenses
      • ๐Ÿ“ˆIncome
      • ๐Ÿ““Debt
      • ๐ŸงฎAverages
    • ๐Ÿ“‘Statements
      • ๐Ÿ—ƒ๏ธReturn All Account Statements
      • ๐Ÿ“Return All Statements of a BankAccount
      • ๐ŸšฎReturn All Failed Statements
      • ๐Ÿ“„Return a Single Statement
      • ๐ŸŽ’Return Bankstatements for BankAccount
      • ๐ŸŸฅReturn Transactions for a Single Statement
    • ๐ŸฆBank Accounts
      • ๐ŸŽญValidate Bank Account Owner
  • ๐Ÿ†”Identity Validation
    • Single Identity CRUD
      • โž•Create New Identity
      • ๐Ÿ”ŽFind a Single Identity
      • โฌ†๏ธUpdate Identity
      • โŒDelete Identity
    • ๐Ÿ—‚๏ธUpload ID Document File
    • โ˜‘๏ธReturn Identity Document Validation
    • ๐Ÿ—ƒ๏ธReturn All Identity Documents
  • ๐ŸกAddress Validation
    • ๐Ÿ Address
      • Single Address CRUD
        • โž•Create New Address
        • ๐Ÿ”ŽFind a Single Address
        • โฌ†๏ธUpdate Address
        • โŒDelete Address
      • ๐ŸจGet All Addresses
    • ๐Ÿ“ƒAddress Documents
      • Single Address Document CRUD
        • โž•Create Address Document
        • ๐Ÿ”ŽFind a Single Address Document
        • โฌ†๏ธUpdate Address Document
        • โŒDelete Address Document
      • โœ…Return Address Document Validation
      • ๐Ÿ“–Get All Address Documents
  • ๐Ÿ”ฐAccount Verification
    • Single Account CRUD
      • โž•Create New Account
        • List of banks for Account Verification
      • ๐Ÿ”ŽFind a Single Account
      • โฌ†๏ธUpdate Account
      • โŒDelete Account
    • โœ…Return TU Account Verification
    • โ˜‘๏ธReturn DT Account Verification
    • ๐Ÿ’ณGet All Accounts
  • ๐ŸขBusinesses
    • Single Business CRUD Functions
      • ๐Ÿ™‹Create a Business for a Customer
      • ๐Ÿ™…Create a Business without a Customer
      • ๐Ÿ”ŽFind Business
      • ๐ŸจGet Business by Customer Property
      • โฌ†๏ธUpdate Business
      • ๐ŸšซDelete Business
    • ยฎ๏ธCipc Lookup
      • ๐ŸคBusiness CIPC Lookup
      • ๐Ÿ‘ฉโ€๐Ÿ’ผDirector CIPC Lookup
    • ๐ŸญGet All Businesses
  • ๐Ÿ›๏ธBusiness Affordability
    • Single Business Bank Account CRUD
      • โž•Create with Customer
      • โž•Create without Customer
      • ๐Ÿ”ŽFind a Single Business BankAccount
      • โฌ†๏ธUpdate Business BankAccount
      • โŒDelete Business BankAccount
    • โซBusiness Bank Statement Upload
      • ๐Ÿ“„Upload Business Bank Statement
      • ๐Ÿ๏ธReturn BankStatements for BankAccount
    • ๐Ÿ”ขBusiness Transactions
      • โš–๏ธReturn all Transactions from a Business Bank Account
      • ๐ŸŸฉReturn a Single Transaction
    • ๐Ÿ—ƒ๏ธAccounts
      • ๐Ÿ’ฐReturn All Accounts of a Bank Account
      • 1๏ธโƒฃReturn a Single Account
    • ๐Ÿ“‘Statements
      • ๐Ÿ—ƒ๏ธReturn All Statements of a BankAccount
      • ๐Ÿ“„Return a Single Statement
      • ๐ŸŸฅReturn Transactions for a Single Statement
    • ๐Ÿ“ˆReports
  • ๐ŸŽฐFincheck Engine Endpoints
    • ๐Ÿ“Get Quote
    • ๐Ÿ“‹Apply Now
  • โ“Gathr FAQs
Powered by GitBook
On this page
  • Basic Affordability Flow
  • Business Affordability

Business Affordability

The Business Affordability Module allows you to upload, validate, process and store business bank statements. Gaining access to the raw transactional data as well as generate summary reports .

Last updated 9 months ago

The transactional data is useful when making an underwriting decision, where a deep understanding of a businesses income, expenses, and financial patterns is required. The Business Affordability Module is packed with powerful tools that can be used by any financial service provider, mobile operator, or employer.

Basic Affordability Flow

Below is a synopsis of the steps you need to take to complete the affordability module using Gathr.

Business Affordability

  1. Create a Business

  2. Create a Business Bank Account

  3. Upload Business Bank Statement

  4. Reports / Statements / Transactions

๐Ÿ›๏ธ
POST Create a Business with a Customer
POST Create a Business without a Customer.
POST Create with Customer
POST Create without Customer
POST Upload Business Bank Statement

Reports

Statements

Transactions

POST Summary Plus
GET Return All Statements of a BankAccount
GET Return all Transaction from a BankAccount
Overview of Affordability v1