Overview (DRAFT) IN PROGRESS

TaaS API Documentation

Welcome to the TaaS (Transactions-as-a-Service) API Platform — a complete infrastructure to manage user onboarding, KYC, banking, wallets, deposits, and crypto-fiat conversions (onramp & offramp).

This documentation provides everything you need to integrate and build on top of the platform.

---

🌐 Overview

The TaaS APIs enable you to:

• 👤 Create and manage user accounts

• 🛂 Perform KYC & NRI KYC verification

• 🏦 Link and manage bank accounts

• 💼 Manage fiat & crypto wallets

• 💸 Handle deposits (fiat & crypto)

• 🔄 Convert fiat ↔ crypto (Onramp & Offramp)

• 📊 Track transactions and balances

---

🧩 Core Modules

1. 👤 Account Management

• Create account

• Update user details

• Fetch account(s)

• Manage main account

---

2. 🛂 KYC (Know Your Customer)

• Initiate KYC session

• Submit documents (PAN, Aadhaar, Passport, DL, Voter ID)

• Upload document files (images/XML)

• Selfie & face matching

• Fetch KYC status

---

3. 🌍 NRI KYC

• Country-specific verification flows

• Dynamic document requirements (USA, UAE, etc.)

• Submit identity & supporting documents

• Track verification sessions

---

4. 🏦 Banking

• Add bank accounts

• Fetch linked banks

• Delete bank accounts

---

5. 💼 Wallets & Assets

• View wallet balances (INR, USDT, AED, etc.)

• Manage whitelisted crypto addresses

• Risk scoring & compliance checks

---

6. 💰 Deposits

• Fiat deposits (INR, AED)

• Crypto deposits (on-chain transactions)

• Deposit instructions & tracking

• Limit management (daily, monthly, etc.)

---

7. 🔄 Onramp (Fiat → Crypto)

• Get supported routes (e.g., INR → USDT)

• Generate real-time quotes

• Place buy orders

• Track order execution

---

8. 🔄 Offramp (Crypto → Fiat)

• Convert crypto to fiat

• Withdraw to bank accounts

• Generate quotes & execute sell orders

• Track order lifecycle

---

🔐 Authentication

All APIs require an API Key passed in headers:

API-KEY: <your-api-key>

For endpoints requiring a payload:

Content-Type: application/json

---

📦 Base URLs

Environment	Base URL
Local	http://127.0.0.1:8000
Staging	<staging-url>
Production	<production-url>

---

⚙️ Common Concepts

🔸 Account ID

Used across APIs to identify a user account.

🔸 KYC Session

A unique session created for identity verification.

🔸 Quote

A time-bound price for conversion (onramp/offramp).

🔸 Order

Represents a transaction (buy/sell crypto).

---

🔁 Typical User Flow

✅ Onboarding & KYC

1. Create Account

2. Initiate KYC

3. Submit Documents

4. Complete Verification

---

💰 Fiat Deposit → Crypto Buy (Onramp)

1. Add Bank Account

2. Deposit INR/AED

3. Generate Quote

4. Place Buy Order

---

💸 Crypto Sell → Fiat Withdrawal (Offramp)

1. Generate Quote

2. Place Sell Order

3. Receive funds in bank

---

⚠️ Error Handling

Standard error format:

{
  "error": "Validation failed",
  "details": {
    "errors": ["Description of error"]
  }
}

---

📊 Rate Limits & Compliance

• Transactions are subject to daily, weekly, monthly limits

• KYC is required for full access

• AML & risk scoring applied for crypto operations

---

🧠 Best Practices

• Always validate quotes before placing orders

• Handle expired quotes

• Store account_id, quote_id, and session_id securely

• Implement retry logic for network failures

---

📞 Support

For integration help or issues:

• Contact: <your-support-email>

• Provide: account_id, request payload, and error response

---

🚀 Getting Started

Jump into the modules:

• 👉 Account APIs

• 👉 KYC APIs

• 👉 Bank APIs

• 👉 Wallet APIs

• 👉 Onramp APIs

• 👉 Offramp APIs

• 👉 Enhance Due Diligence (EDD)