> ## Documentation Index
> Fetch the complete documentation index at: https://docs-sandbox.sparkle.fyi/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the Open Banking API documentation

# Open Banking API

Welcome to the Open Banking API documentation. Our platform provides secure, compliant access to financial data and payment services in Nigeria, enabling innovative fintech applications and seamless banking experiences.

## What is Open Banking?

The Nigerian Open Banking API is designed to empower application developers, fintechs, and financial service providers with standardized, secure access to customer financial data—under the customer’s consent. The core goal is to enable innovation while safeguarding sensitive information such as card PINs, OTPs, and passwords.

By leveraging the API, developers can build capabilities in key areas such as:

* **Account Aggregation**: View all your accounts in one place
* **Payment Initiation**: Make secure payments directly from your bank account
* **Financial Management**: Better insights into spending and saving patterns
* **Innovation**: New financial products and services

## Key Features

<Columns cols={2}>
  <Card title="Customer Management" link="link" href="/guides/customers" arrow="true">
    Manage Customer details, understand their profile using personal information
  </Card>

  <Card title="Account Management" link="link" href="/guides/accounts" arrow="true">
    See Real-time account balances and details, transaction history
  </Card>
</Columns>

<Columns cols={2}>
  <Card title="Transfers" link="link" href="/guides/transfers" arrow="true">
    Make direct bank transfers and payments. Payment status tracking.
  </Card>

  <Card title="Bill Payments" link="link" href="/guides/bill-payments" arrow="true">
    Pay your bills: DSTV, Internet Data etc
  </Card>
</Columns>

<Columns cols={2}>
  <Card title="Card Management" link="link" href="/guides/cards" arrow="true">
    Issue Payment Cards
  </Card>

  <Card title="Loan Information" link="link" href="/guides/loan-information" arrow="true">
    View your customer Loan informations
  </Card>
</Columns>

These capabilities pave the way for the development of next-generation financial services. For example, lenders can assess a borrower’s financial health based on real transaction data, businesses can verify sufficient account balances before processing payments, and users can automate bill payments from multiple accounts—all within a safe and regulated ecosystem.

The Nigerian Open Banking API is a foundational step toward a more transparent, customer-centric financial landscape, fostering trust, security, and innovation.

## Secure Authentication

* OAuth 2.0 via Authorisation Code for smart devices
* OAuth 2.0 via Device Code Authorisation for dumb devices
* OAuth 2.0 with PKCE for enhanced security for Single page application
* Dynamic Client Registration for instant access
* Bearer token authentication for API calls
* Fine-grained customer consent approval by resource
* Capability for customer to revoke approved consent at any time

## Compliance & Security

Our API is fully compliant with:

* Nigerian Open Banking Standards
* **GDPR** for data protection
* **PCI DSS** and **ISO 27001** certified
* End-to-end encryption
* Audit logging and monitoring

## Developer Experience

* Comprehensive API documentation
* Sandbox environment for testing
* SDKs and code examples
* Webhook support for real-time updates

## Use Cases

<CodeGroup>
  ```markdown Personal Finance Management theme={null}
  **Personal Finance Management**
  - Track spending across multiple accounts
  - Set budgets and financial goals
  - Analyze spending patterns
  - Generate financial reports

  **Track spending across multiple accounts**
  - View all your accounts in one dashboard
  - Monitor real-time balances and transactions
  - Categorize spending automatically
  - Set up alerts for unusual activity

  **Set budgets and financial goals**
  - Create monthly budgets by category
  - Track progress towards savings goals
  - Receive notifications when approaching limits
  - Analyze spending vs. budgeted amounts

  **Analyze spending patterns**
  - Generate spending reports by category
  - Identify trends and patterns over time
  - Compare spending across different periods
  - Export data for external analysis
  ```

  ```markdown Business Banking theme={null}
  **Automate payment processing**
  - Schedule recurring payments
  - Batch payment processing
  - Vendor payment automation
  - Payroll processing integration

  **Reconcile transactions**
  - Automatic transaction matching
  - Bank statement reconciliation
  - Discrepancy identification
  - Audit trail maintenance

  **Monitor cash flow**
  - Real-time cash flow tracking
  - Cash flow forecasting
  - Liquidity monitoring
  ```

  ```markdown Lending and Credit theme={null}
  **Verify income and employment**
  - Automated income verification
  - Salary history analysis

  **Assess creditworthiness**
  - Credit score analysis
  - Debt-to-income ratio calculation
  - Payment history review
  - Risk assessment models

  **Monitor loan repayments**
  - Payment tracking and reminders
  - Late payment detection
  - Default risk monitoring
  ```
</CodeGroup>

<Note>
  This documentation is continuously updated. Subscribe to our changelog to stay informed about new features and updates.
</Note>

<Button href="/quickstart" size="lg">
  Start Building
</Button>