# Spare API Docs

> Open banking APIs for payment initiation, account information, and verification across UAE, KSA, and Bahrain. Official SDKs for TypeScript, Python, Java, C#, and Go.

The full documentation as a single Markdown file is at /llms-full.txt.

## Docs

- [Coverage](https://docs.tryspare.com/llms.mdx/docs/coverage/content.md): Which Spare services are available in each market, and the tenant your API calls should use.
- [Spare API Documentation](https://docs.tryspare.com/llms.mdx/docs/content.md): Developer documentation for the Spare Open Finance Platform
- [Authentication](https://docs.tryspare.com/llms.mdx/docs/api-reference/authentication/content.md): Obtain and refresh API access tokens using client credentials.
- [Bank Accounts](https://docs.tryspare.com/llms.mdx/docs/api-reference/bank-accounts/content.md): Register and manage creditor bank accounts for payment settlement.
- [Beneficiary Verification](https://docs.tryspare.com/llms.mdx/docs/api-reference/beneficiary-verification/content.md): Confirm the registered owner of a UAE IBAN before initiating a payment.
- [Authentication](https://docs.tryspare.com/llms.mdx/docs/api-reference/bh-authentication/content.md): Obtain and refresh API access tokens, and fetch signing keys.
- [API Reference](https://docs.tryspare.com/llms.mdx/docs/api-reference/content.md): Interactive reference for all Spare Open Finance Platform endpoints.
- [Authentication](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-authentication/content.md): Obtain and refresh API access tokens, and fetch signing keys.
- [Mandates](https://docs.tryspare.com/llms.mdx/docs/api-reference/mandates/content.md): Schedule, approve, and list transactions for recurring payment mandates.
- [Payment Consents](https://docs.tryspare.com/llms.mdx/docs/api-reference/payment-consents/content.md): Manage payment consent lifecycle, list, sync, retrieve, and update consents.
- [Payment Purpose Codes](https://docs.tryspare.com/llms.mdx/docs/api-reference/payment-purpose-codes/content.md): List valid payment purpose codes for your region.
- [Payment Requests](https://docs.tryspare.com/llms.mdx/docs/api-reference/payment-requests/content.md): Create, list, retrieve, reconcile, and cancel payment requests.
- [Payments](https://docs.tryspare.com/llms.mdx/docs/api-reference/payments/content.md): List and retrieve settled payments.
- [Providers](https://docs.tryspare.com/llms.mdx/docs/api-reference/providers/content.md): List available open banking providers and institutions.
- [Refunds](https://docs.tryspare.com/llms.mdx/docs/api-reference/refunds/content.md): Create a refund payment request, or read the payer refund account.
- [Webhook Event Format](https://docs.tryspare.com/llms.mdx/docs/api-reference/webhook-events/content.md): The HTTP request Spare sends to your callback URL, with decoded examples for each resource type.
- [Webhooks](https://docs.tryspare.com/llms.mdx/docs/api-reference/webhooks/content.md): Manage webhook subscriptions and browse the event catalog.
- [AlTareq Framework](https://docs.tryspare.com/llms.mdx/docs/appendix/altareq/content.md): CBUAE's Open Finance scheme for consent, data sharing, and payment initiation in the UAE.
- [Live Banks](https://docs.tryspare.com/llms.mdx/docs/appendix/banks/content.md): UAE banks live on Spare today for payments and account information, split by retail and SME or corporate.
- [Appendix](https://docs.tryspare.com/llms.mdx/docs/appendix/content.md): UAE scheme reference and lookup tables for AlTareq, purpose codes, and live banks.
- [Purpose Codes](https://docs.tryspare.com/llms.mdx/docs/appendix/purpose-codes/content.md): UAE domestic and international payment purpose codes for the purpose field on payment requests.
- [Account Information for UAE](https://docs.tryspare.com/llms.mdx/docs/changelog/2026-08-19/content.md): UAE account requests, consents, data sync, and risk reports land on the contract alongside payment initiation.
- [One-call account access](https://docs.tryspare.com/llms.mdx/docs/changelog/2026-09-03/content.md): Create account access in a single call, then create a risk report with the same referenceCustomerId.
- [Webhooks and International Payments](https://docs.tryspare.com/llms.mdx/docs/changelog/2026-09-09/content.md): Webhooks are live for UAE payments, one consent can pay several beneficiaries, and cross-border payments have their own guides.
- [Refunds, Link Web SDK, and Reconciliation](https://docs.tryspare.com/llms.mdx/docs/changelog/2026-10-27/content.md): UAE refunds, the Link Web SDK, and one call for every status on a payment request.
- [Changelog](https://docs.tryspare.com/llms.mdx/docs/changelog/content.md): API changes over time, new endpoints, changed behavior, and deprecations.
- [Account Information](https://docs.tryspare.com/llms.mdx/docs/concepts/account-information/content.md): Read a customer's accounts, balances, and transactions from their bank, securely, with their consent.
- [Consent Lifecycle](https://docs.tryspare.com/llms.mdx/docs/concepts/consent-lifecycle/content.md): Payment consent states, transitions, and when to poll or use webhooks.
- [Concepts](https://docs.tryspare.com/llms.mdx/docs/concepts/content.md): Understand payment flows, consent lifecycle, mandates, Spare Link, and webhooks.
- [Mandates](https://docs.tryspare.com/llms.mdx/docs/concepts/mandates/content.md): Recurring and future-dated payments through mandate scheduling and approval.
- [Open Banking](https://docs.tryspare.com/llms.mdx/docs/concepts/open-banking/content.md): What open banking means in the Spare platform and how consent drives access.
- [Payment Flow](https://docs.tryspare.com/llms.mdx/docs/concepts/payment-flow/content.md): End-to-end flow from payment request to settled payment.
- [Account Information](https://docs.tryspare.com/llms.mdx/docs/concepts/uae-account-information/content.md): Read a customer's bank data through account access, authorization, and optional risk reports.
- [Verification](https://docs.tryspare.com/llms.mdx/docs/concepts/verification/content.md): Identity, account, and business verification services for confirming who you're dealing with before you move money.
- [Webhooks](https://docs.tryspare.com/llms.mdx/docs/concepts/webhooks/content.md): How Spare delivers signed events to your server and how they fit with polling.
- [FAQ](https://docs.tryspare.com/llms.mdx/docs/faq/content.md): Common questions about Spare payment initiation and beneficiary verification in the UAE.
- [Guides](https://docs.tryspare.com/llms.mdx/docs/guides/content.md): Hands-on walkthroughs for common Spare integration paths.
- [Data Types](https://docs.tryspare.com/llms.mdx/docs/quickstart/data-types/content.md): Field formats used consistently across every Spare API response
- [Error Codes](https://docs.tryspare.com/llms.mdx/docs/quickstart/error-codes/content.md): HTTP status codes and error response shape used across every endpoint.
- [Going Live on Production](https://docs.tryspare.com/llms.mdx/docs/quickstart/going-live/content.md): Move your integration from the sandbox to the production environment.
- [Integration Flow](https://docs.tryspare.com/llms.mdx/docs/quickstart/integration-flow/content.md): The request sequence every integration follows, authenticate, discover, consent, authorize, access.
- [Introduction](https://docs.tryspare.com/llms.mdx/docs/quickstart/introduction/content.md): What the Spare Open Finance Platform is and how to begin integrating, for any use case.
- [Request Signing](https://docs.tryspare.com/llms.mdx/docs/quickstart/request-signing/content.md): Sign write requests with a detached ES256 JWS in the x-signature header, where the market requires it.
- [Sandbox Testing](https://docs.tryspare.com/llms.mdx/docs/quickstart/sandbox-testing/content.md): Test your integration end-to-end against the sandbox before going live.
- [Quick Start Setup](https://docs.tryspare.com/llms.mdx/docs/quickstart/setup/content.md): Create API credentials, configure a webhook endpoint, and authenticate.
- [Invite Team Members](https://docs.tryspare.com/llms.mdx/docs/quickstart/team/content.md): Give teammates access to your Spare Dashboard for development and support.
- [Ticketing System](https://docs.tryspare.com/llms.mdx/docs/quickstart/ticketing-system/content.md): How do you report issues?
- [Coming soon](https://docs.tryspare.com/llms.mdx/docs/roadmap/content.md): A first look at what Spare is building next across markets.
- [C# SDK](https://docs.tryspare.com/llms.mdx/docs/sdk/csharp/content.md): Install, configure, and use the SpareApi .NET package.
- [Flutter](https://docs.tryspare.com/llms.mdx/docs/sdk/flutter/content.md): Add Spare's open banking payment SDK to a Flutter app for iOS and Android in the UAE.
- [Go SDK](https://docs.tryspare.com/llms.mdx/docs/sdk/go/content.md): Install, configure, and use the Spare Go SDK.
- [SDK](https://docs.tryspare.com/llms.mdx/docs/sdk/content.md): Official Spare client libraries, or REST integration where SDKs aren't yet available.
- [Java SDK](https://docs.tryspare.com/llms.mdx/docs/sdk/java/content.md): Install, configure, and use the com.spare:spare-api package.
- [SDK Overview](https://docs.tryspare.com/llms.mdx/docs/sdk/overview/content.md): Official Spare client libraries, or REST integration where SDKs aren't yet available.
- [Python SDK](https://docs.tryspare.com/llms.mdx/docs/sdk/python/content.md): Install, configure, and use the spare-api Python package.
- [React Native](https://docs.tryspare.com/llms.mdx/docs/sdk/react-native/content.md): Add Spare's open banking payment SDK to a React Native or Expo app for the UAE.
- [TypeScript SDK](https://docs.tryspare.com/llms.mdx/docs/sdk/typescript/content.md): Install, configure, and use the @spare-technologies/spare-api npm package.
- [Link Web SDK](https://docs.tryspare.com/llms.mdx/docs/sdk/web/content.md): Add Spare Link to a website with React or plain JavaScript. Payments, mandates and account information for the UAE.
- [Consents](https://docs.tryspare.com/llms.mdx/docs/api-reference/bh-payment-initiation/consents/content.md): Create, list, and retrieve payment consents.
- [Payment Initiation](https://docs.tryspare.com/llms.mdx/docs/api-reference/bh-payment-initiation/content.md): Discover providers, create payment requests, collect consent, and track payments.
- [Payment Requests](https://docs.tryspare.com/llms.mdx/docs/api-reference/bh-payment-initiation/payment-requests/content.md): Create, list, retrieve, and delete payment requests.
- [Payments](https://docs.tryspare.com/llms.mdx/docs/api-reference/bh-payment-initiation/payments/content.md): List and retrieve payments.
- [Providers](https://docs.tryspare.com/llms.mdx/docs/api-reference/bh-payment-initiation/providers/content.md): List available open banking providers and institutions.
- [Accounts & Balances](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/accounts-balances/content.md): List accounts and read current and historical balances.
- [Beneficiaries & Parties](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/beneficiaries-parties/content.md): Beneficiaries, account parties, and direct debits.
- [Connections & Consents](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/connections-consents/content.md): Create account connections and manage consent.
- [Customers](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/customers/content.md): Create, list, retrieve, update, and delete customer records.
- [Account Information](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/content.md): Accounts, balances, transactions, statements, and consent connections.
- [Providers & Requests](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/providers-requests/content.md): Provider directory and account information request management.
- [Statements & Reports](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/statements-reports/content.md): PDF statements and account information reports.
- [Transactions](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-account-information/transactions/content.md): Retrieve transaction history and salary transactions.
- [Account Verification Pro](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-verification/account-verification-pro/content.md): Combined match and beneficiary lookup for retail and corporate accounts.
- [Account Verification](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-verification/account-verification/content.md): Match a bank account (IBAN) to an identity.
- [Beneficiary Verification](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-verification/beneficiary-verification/content.md): Resolve the registered owner behind an IBAN.
- [Commercial Registration](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-verification/commercial-registration/content.md): Look up company registration and business details.
- [Common Verification](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-verification/common-verification/content.md): Combined retail and corporate account verification.
- [Freelancer Verification](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-verification/freelancer-verification/content.md): Verify a freelancer certificate and its status.
- [Verification](https://docs.tryspare.com/llms.mdx/docs/api-reference/ksa-verification/content.md): Identity, account, beneficiary, and business verification endpoints.
- [Account Consents](https://docs.tryspare.com/llms.mdx/docs/api-reference/uae-account-information/account-consents/content.md): Create, list, and retrieve account data consents.
- [Account Requests](https://docs.tryspare.com/llms.mdx/docs/api-reference/uae-account-information/account-requests/content.md): Create, list, retrieve, update, and delete account information requests.
- [Authorization](https://docs.tryspare.com/llms.mdx/docs/api-reference/uae-account-information/authorization/content.md): Customer bank authorization for an account-information consent.
- [Create Account Access](https://docs.tryspare.com/llms.mdx/docs/api-reference/uae-account-information/create-account-access/content.md): Create an account-information request and consent in one call.
- [Account Information](https://docs.tryspare.com/llms.mdx/docs/api-reference/uae-account-information/content.md): Account access, consents, authorization, and risk reports.
- [Risk Reports](https://docs.tryspare.com/llms.mdx/docs/api-reference/uae-account-information/risk-reports/content.md): Create, list, retrieve, export, and delete risk reports for an authorized customer.
- [Sync](https://docs.tryspare.com/llms.mdx/docs/api-reference/uae-account-information/sync/content.md): Start bulk account data sync jobs and poll their status.
- [Accounts](https://docs.tryspare.com/llms.mdx/docs/guides/account-information/accounts/content.md): Retrieve a customer's bank accounts, current, savings, cards, loans, and investments, once consent is active.
- [Balances & Transactions](https://docs.tryspare.com/llms.mdx/docs/guides/account-information/balances-and-transactions/content.md): Retrieve real-time account balances and a filterable history of transactions for a consented account.
- [Account Information Guides](https://docs.tryspare.com/llms.mdx/docs/guides/account-information/content.md): Read a customer's accounts, balances, and transactions once they've authorized access.
- [Transaction Data Object](https://docs.tryspare.com/llms.mdx/docs/guides/account-information/transaction-data-object/content.md): The field-level structure of an AIS transaction, parties, amounts, codes, and dates.
- [Setup your Bank Account](https://docs.tryspare.com/llms.mdx/docs/guides/payments/bank-account-setup/content.md): Register creditor bank accounts and set a default for settlements.
- [Setup Your First Mandate](https://docs.tryspare.com/llms.mdx/docs/guides/payments/first-mandate-sandbox/content.md): Create a Variable On Demand payment request in the UAE sandbox, complete bank consent, and obtain a mandate.
- [Make Your First Payment](https://docs.tryspare.com/llms.mdx/docs/guides/payments/first-payment-sandbox/content.md): Complete a Single Instant Payment in the UAE sandbox using Spare hosted pages.
- [Payments](https://docs.tryspare.com/llms.mdx/docs/guides/payments/content.md): Overview of Spare payment initiation, supported payment types, user journeys, SDKs, and quick integration guides.
- [Manage Your Mandates](https://docs.tryspare.com/llms.mdx/docs/guides/payments/manage-mandates/content.md): List, approve, schedule, and immediately post mandate transactions for UAE multi-payment types.
- [Reconciliation](https://docs.tryspare.com/llms.mdx/docs/guides/payments/reconciliation/content.md): Read the status Spare has on record for a UAE payment request, its payments, and its mandates.
- [Refunds](https://docs.tryspare.com/llms.mdx/docs/guides/refunds/content.md): Return money to the payer of a completed UAE payment, in part or more than once.
- [Issue a Refund](https://docs.tryspare.com/llms.mdx/docs/guides/refunds/issuing-a-refund/content.md): Prepare a UAE payment for a refund, then either ask Spare to pay it or read the payer account and pay it yourself.
- [Account Information](https://docs.tryspare.com/llms.mdx/docs/guides/uae-account-information/content.md): Integrate providers, account access, authorization, and risk reports.
- [Risk Report](https://docs.tryspare.com/llms.mdx/docs/guides/uae-account-information/risk-report/content.md): Create, poll, retrieve, and export a risk report for an authorized customer.
- [Account Verification Pro](https://docs.tryspare.com/llms.mdx/docs/guides/verification/account-verification-pro/content.md): Verify a bank account and retrieve beneficiary information for retail or corporate accounts in one call.
- [Account Verification (AV)](https://docs.tryspare.com/llms.mdx/docs/guides/verification/account-verification/content.md): Confirm a bank account (IBAN) belongs to a given identity, and get a clear match / no-match result.
- [Beneficiary Verification](https://docs.tryspare.com/llms.mdx/docs/guides/verification/beneficiary-verification-uae/content.md): Confirm the registered account holder behind a UAE IBAN before initiating a payment.
- [Beneficiary Verification (BV)](https://docs.tryspare.com/llms.mdx/docs/guides/verification/beneficiary-verification/content.md): Retrieve the registered owner behind an IBAN and confirm it matches your intended beneficiary.
- [Commercial Registration](https://docs.tryspare.com/llms.mdx/docs/guides/verification/commercial-registration/content.md): Retrieve verified company registration and business details using a unified registration number.
- [Freelance Verification](https://docs.tryspare.com/llms.mdx/docs/guides/verification/freelance-verification/content.md): Verify a freelancer's certificate and its status using their National ID and certificate number.
- [Verification Guides](https://docs.tryspare.com/llms.mdx/docs/guides/verification/content.md): Integrate identity, account, beneficiary, and business verification services.
- [Event Catalog](https://docs.tryspare.com/llms.mdx/docs/guides/webhooks/event-catalog/content.md): Products, resources, and event names available for UAE webhook subscriptions today.
- [How Webhooks Work](https://docs.tryspare.com/llms.mdx/docs/guides/webhooks/content.md): Subscription model, authentication, request signing, base URLs, and the two signatures you will encounter.
- [Receive Events](https://docs.tryspare.com/llms.mdx/docs/guides/webhooks/receiving-events/content.md): Verify the signed delivery, return 202 Accepted, handle retries, and go live.
- [Manage Subscriptions](https://docs.tryspare.com/llms.mdx/docs/guides/webhooks/subscriptions/content.md): Create, list, retrieve, update, pause, and delete webhook subscriptions via the Spare API.
- [Fixed Defined Schedule](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/fixed-defined-schedule/content.md): Instructions fields for FixedDefinedSchedule on POST /payment-requests.
- [Fixed On Demand](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/fixed-on-demand/content.md): Instructions fields for FixedOnDemand on POST /payment-requests.
- [Fixed Periodic Schedule](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/fixed-periodic-schedule/content.md): Instructions fields for FixedPeriodicSchedule on POST /payment-requests.
- [Payment Request Deep Dives](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/content.md): Field-level controls for each payment type on POST /payment-requests.
- [International Payments Deep Dive](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/international-payment/content.md): Request fields and validation rules for UAE cross-border payments.
- [Single Instant Payment](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/single-instant-payment/content.md): Instructions fields for SingleInstantPayment on POST /payment-requests.
- [Variable Defined Schedule](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/variable-defined-schedule/content.md): Instructions fields for VariableDefinedSchedule on POST /payment-requests.
- [Variable On Demand](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/variable-on-demand/content.md): Instructions fields for VariableOnDemand on POST /payment-requests.
- [Variable Periodic Schedule](https://docs.tryspare.com/llms.mdx/docs/guides/payments/deep-dives/variable-periodic-schedule/content.md): Instructions fields for VariablePeriodicSchedule on POST /payment-requests.
- [Defined Schedule Payments](https://docs.tryspare.com/llms.mdx/docs/guides/payments/payment-types/defined-schedule/content.md): Integrate FixedDefinedSchedule and VariableDefinedSchedule payment types.
- [Payment Type Guides](https://docs.tryspare.com/llms.mdx/docs/guides/payments/payment-types/content.md): Choose and implement the right payment flow for your product.
- [International Payments](https://docs.tryspare.com/llms.mdx/docs/guides/payments/payment-types/international/content.md): Use UAE Open Finance payments for cross-border transfers.
- [On-Demand Payments](https://docs.tryspare.com/llms.mdx/docs/guides/payments/payment-types/on-demand/content.md): Integrate FixedOnDemand and VariableOnDemand payment types.
- [Recurring & Periodic Payments](https://docs.tryspare.com/llms.mdx/docs/guides/payments/payment-types/recurring-scheduled/content.md): Integrate FixedPeriodicSchedule and VariablePeriodicSchedule payment types.
- [Single Instant Payment](https://docs.tryspare.com/llms.mdx/docs/guides/payments/payment-types/single-instant/content.md): Integrate a one-off immediate payment (SingleInstantPayment).
- [Consent Permissions](https://docs.tryspare.com/llms.mdx/docs/guides/payments/user-journeys/consent-permissions/content.md): Request account and balance data on the payment consent with consentPermissions.
- [Debtor Account](https://docs.tryspare.com/llms.mdx/docs/guides/payments/user-journeys/debtor-account/content.md): Pre-supply the payer IBAN on create so the hosted flow skips bank-account selection.
- [Existing User](https://docs.tryspare.com/llms.mdx/docs/guides/payments/user-journeys/existing-user/content.md): Capture payer accounts with x-customer-id, list them, and reuse them on later payment requests.
- [User Journeys](https://docs.tryspare.com/llms.mdx/docs/guides/payments/user-journeys/content.md): Optional create-time controls that change the hosted payer flow, consent data, or Variable On Demand creditors.
- [Variable On Demand with Multiple Beneficiaries](https://docs.tryspare.com/llms.mdx/docs/guides/payments/user-journeys/multiple-beneficiaries/content.md): Authorize several creditor accounts on one VariableOnDemand consent, then choose the payee on each schedule.
- [Pre-selected Provider](https://docs.tryspare.com/llms.mdx/docs/guides/payments/user-journeys/pre-selected-provider/content.md): Pre-supply providerId from GET /providers so the hosted flow skips bank selection.

## API specifications

Machine-readable OpenAPI specs (also indexed at /.well-known/api-catalog):

- [Spare API, UAE](https://docs.tryspare.com/openapi/uae.json)
- [KSA, Authentication](https://docs.tryspare.com/openapi/ksa/auth.json)
- [KSA, Account Information (v1)](https://docs.tryspare.com/openapi/ksa/ais.json)
- [KSA, Account Information (v2)](https://docs.tryspare.com/openapi/ksa/ais-v2.json)
- [KSA, Verification](https://docs.tryspare.com/openapi/ksa/verification.json)
- [KSA, Verification Pro](https://docs.tryspare.com/openapi/ksa/verification-pro.json)
- [Bahrain, Authentication](https://docs.tryspare.com/openapi/bh/auth.json)
- [Bahrain, Payment Initiation](https://docs.tryspare.com/openapi/bh/pis.json)