Welcome to Spare
Spare is the Open Finance API for the Middle East.
Access payment initiation, account information, and identity verification across the UAE, Saudi Arabia, and Bahrain, with capabilities tailored to and compliant with each market's Open Banking and Open Finance frameworks.
Start in minutes
From credentials to your first API call
import { Configuration, SpareApiClient } from "@spare-technologies/spare-api";const config = new Configuration({ appId: process.env.SPARE_APP_ID!, apiKey: process.env.SPARE_API_KEY!, tenant: "UAE", environment: "sandbox",});const client = new SpareApiClient({ authProvider: config });const payment = await client.paymentRequests.create({ amount: 100_00, currency: "AED", description: "Invoice #12345", redirectUrl: "https://yourapp.com/payments/callback",});console.log(payment.data.id);Recommended path
- 1. Create a sandbox account and API credentials.
- 2. Authenticate and discover providers for your tenant.
- 3. Create a consent for your use case.
- 4. Complete customer authorization.
- 5. Access the result via API or webhooks.
3
markets (UAE · KSA · Bahrain)
5
official SDKs
95
documented operations
Explore by topic
Documentation map
Each section answers a different integration question, onboarding, concepts, hands-on guides, SDK usage, or endpoint-level detail.
Quickstart
Get sandbox credentials, authenticate, and learn the request flow that's the same for every service.
Coverage
Which services are live in each market, UAE, Saudi Arabia, and Bahrain, and the tenant your calls should use.
API Reference
Grouped endpoints with schemas, examples, and try-it panels generated from our OpenAPI specs.
Concepts
How open banking, payment initiation, account information, verification, and consent fit together.
Guides
Copy-pasteable walkthroughs, accept a payment, integrate verification, or read account information.
Official SDKs
Typed clients for TypeScript, Python, Java, C#, and Go with automatic token refresh and aligned models.
Where to start
Reading paths
End-to-end routes by use case: the concept to read, the guide to follow, and the API reference to build against.
Concept
Account informationGuides
AIS guidesAPI reference
Account Information API