Getting Started

Welcome to the Apache Fineract API documentation. This guide will help you get started with integrating Fineract into your application.

What is Apache Fineract?

Apache Fineract is an open source core banking platform that provides a reliable, robust, and affordable solution for financial services. It supports all core banking functions including:

Client and group management
Savings and deposit accounts
Loan products and disbursement
Accounting and financial reporting
User and role management

Prerequisites

Before you begin, ensure you have:

A running Fineract instance (self-hosted or cloud)
Valid API credentials (username and password)
Your tenant identifier

Your First API Request

Let's start by making a simple request to list all offices in your organization. This will verify your credentials are working correctly.

bash

curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/offices" \
  --header "Authorization: Basic $(echo -n 'mifos:password' | base64)" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

If successful, you'll receive a JSON array containing your organization's office structure.