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

# OLIVE Payment Platform

> Unified payment platform with conversational AI, secure transactions, and comprehensive compliance

<img src="https://mintcdn.com/olive/1iuKbSYkEo7vmLTo/images/olive-hero.svg?fit=max&auto=format&n=1iuKbSYkEo7vmLTo&q=85&s=a5dc5743a4fe9b703b23f439acec616a" alt="OLIVE Platform" style={{borderRadius: '12px', marginBottom: '24px'}} width="800" height="300" data-path="images/olive-hero.svg" />

# Welcome to OLIVE

OLIVE is a **three-tier payment platform** combining a secure transaction engine, a public API gateway, and conversational agents that provide natural-language experiences via WhatsApp.

***

## Platform Components

<CardGroup cols={3}>
  <Card title="Agent-TS" icon="bot" color="#10b981" href="/agent-ts/overview">
    **Conversational AI**

    OpenAI-powered agent for WhatsApp integrations and natural language wallet operations
  </Card>

  <Card title="Gateway" icon="server" color="#6366f1" href="/gateway/overview">
    **REST API Gateway**

    Full REST API with authentication, rate limiting, and comprehensive logging
  </Card>

  <Card title="Wallet-Core" icon="wallet" color="#f59e0b" href="/wallet-core/overview">
    **Financial Engine**

    Secure ledger with atomic transactions and compliance monitoring
  </Card>
</CardGroup>

***

## Architecture

```mermaid theme={null}
flowchart TB
    subgraph clients["Clients"]
        mobile["Mobile Apps"]
        pos["POS Terminals"]
        whatsapp["WhatsApp"]
    end
    
    clients -->|"HTTPS<br/>API Keys / JWT / HMAC"| gateway
    
    subgraph gateway["Gateway (REST API)"]
        gw_features["Rate Limiting • Auth • Logging"]
    end
    
    gateway -->|"gRPC (mTLS)"| walletcore
    
    subgraph walletcore["Wallet-Core (Ledger)"]
        wc_features["Transactions • Accounts • Audit"]
    end
    
    walletcore --> db
    
    subgraph db["PostgreSQL DB"]
        db_features["Accounts • Transactions • Logs"]
    end
    
    style clients fill:#1e293b,stroke:#475569,color:#fff
    style gateway fill:#4f46e5,stroke:#818cf8,color:#fff
    style walletcore fill:#d97706,stroke:#fbbf24,color:#fff
    style db fill:#0891b2,stroke:#22d3ee,color:#fff
```

***

## Key Features

<CardGroup cols={3}>
  <Card title="Secure Payments" icon="lock">
    Atomic database transactions with full audit trails
  </Card>

  <Card title="Idempotent API" icon="repeat">
    Request ID-based idempotency for safe retries
  </Card>

  <Card title="AI Assistant" icon="sparkles">
    Natural language wallet operations via WhatsApp
  </Card>

  <Card title="KYC Compliance" icon="shield-check">
    Multi-level KYC with OCR document verification
  </Card>

  <Card title="Fraud Detection" icon="shield-alert">
    Real-time monitoring and suspicious activity alerts
  </Card>

  <Card title="Multi-Auth" icon="key">
    API keys, JWT, HMAC, and service authentication
  </Card>
</CardGroup>

***

## Quick Start

<Steps>
  <Step title="Start Services">
    ```bash theme={null}
    docker compose up -d --build gateway wallet-core agent
    ```
  </Step>

  <Step title="Verify Health">
    ```bash theme={null}
    curl http://localhost:8080/health  # Gateway
    curl http://localhost:8000/health  # Agent
    ```
  </Step>

  <Step title="Get API Key">
    Create an API key through the admin dashboard or CLI
  </Step>

  <Step title="Make First Request">
    ```bash theme={null}
    curl -H "Authorization: Bearer olive_live_xxx" \
      http://localhost:8080/api/v1/health
    ```
  </Step>
</Steps>

<Card title="Full Quickstart Guide" icon="rocket" href="/quickstart">
  Complete setup instructions with configuration and deployment options
</Card>

***

## API Base URLs

| Environment     | Gateway                          | Agent                             |
| --------------- | -------------------------------- | --------------------------------- |
| **Development** | `http://localhost:8080`          | `http://localhost:8000`           |
| **Demo**        | `https://demo.api.vultlocal.com` | `https://agent.olive.example.com` |

***

## Explore

<CardGroup cols={2}>
  <Card title="API Reference" icon="code" href="/api-reference/overview">
    Complete endpoint documentation with examples and response schemas
  </Card>

  <Card title="Integration Guides" icon="book-open" href="/guides/subscriber-registration">
    Step-by-step tutorials for common integration patterns
  </Card>

  <Card title="Architecture" icon="layers" href="/architecture">
    Deep dive into system design and data flows
  </Card>

  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    Learn about API keys, JWT, and HMAC authentication
  </Card>
</CardGroup>

***

## Support

<CardGroup cols={3}>
  <Card title="GitHub" icon="github" href="https://github.com/impkart/olive">
    Source code and issue tracking
  </Card>

  <Card title="Slack" icon="message-circle">
    Join our developer community
  </Card>

  <Card title="Email" icon="mail">
    [support@olive.example.com](mailto:support@olive.example.com)
  </Card>
</CardGroup>