@extends('layouts.public') @section('title', 'API Documentation - FinAegis') @section('seo') @include('partials.seo', [ 'title' => 'API Documentation - FinAegis', 'description' => 'Complete reference documentation for the FinAegis REST API with interactive examples and code samples.', 'keywords' => 'FinAegis API, REST API, API documentation, developer reference', ]) @endsection @section('content')
Complete reference documentation for the FinAegis REST API with interactive examples and code samples.
The FinAegis API provides programmatic access to our multi-asset banking platform spanning 42 DDD domains with over 1,200 routes. Our API is organized around REST principles with predictable, resource-oriented URLs. Domains include core banking, CrossChain bridging, DeFi protocols, RegTech compliance, Mobile Payment, Partner BaaS, and AI-powered queries.
All API responses are returned in JSON format with a consistent structure:
The FinAegis API uses API keys to authenticate requests. You can generate and manage your API keys in your dashboard.
Include your API key in the Authorization header:
Use these base URLs for testing and production:
Retrieve a list of all accounts for the authenticated user.
Retrieve detailed information about a specific account.
Get current balances for all assets in an account.
Get a paginated list of all transactions.
page - Page number (default: 1)per_page - Items per page (default: 20, max: 100)asset_code - Filter by asset codestatus - Filter by statusDeposit funds into an account.
Withdraw funds from an account.
Create a new transfer between accounts.
Get transfer history for a specific account.
The GCU endpoints provide access to real-time data about the Global Currency Unit, including its composition, value history, and governance information.
Get current information about the Global Currency Unit including composition and value.
Get detailed real-time composition data including current weights, values, and recent changes for each component asset.
Get historical value data for the Global Currency Unit.
period - Time period: 24h, 7d, 30d, 90d, 1y, all (default: 30d)interval - Data interval: hourly, daily, weekly, monthly (default: daily)The GCU voting system allows token holders to participate in monthly governance votes to optimize the currency basket composition.
Get all voting proposals with optional status filtering.
status - Filter by status: active, upcoming, past (optional)Get detailed information about a specific voting proposal.
Cast your vote on a proposal. Voting power is determined by your GCU balance.
Get your voting history across all proposals.
Baskets are multi-asset currency units that can be composed and decomposed. The GCU is our primary basket.
Get a list of all available baskets.
Get detailed information about a specific basket.
Convert individual assets into basket units.
Convert basket units back to individual assets.
Webhooks allow you to receive real-time notifications when events occur in your FinAegis account.
Get a list of all available webhook event types.
Create a new webhook endpoint.
Get all webhook endpoints for your account.
Get delivery history for a specific webhook.
The CrossChain API enables multi-chain operations including bridge transfers via Wormhole, LayerZero, and Axelar protocols. Compare bridge fees, execute cross-chain swaps, and track portfolios across multiple blockchains.
7 routes · View in Swagger UI
Initiate a cross-chain bridge transfer through Wormhole, LayerZero, or Axelar.
Compare fees and estimated times across all supported bridge protocols for a given route.
Execute a token swap that bridges and swaps in a single atomic operation.
Retrieve an aggregated portfolio view across all supported chains.
The DeFi API provides access to decentralized finance protocols including DEX aggregation (Uniswap, Curve), lending (Aave), staking (Lido), yield optimization, and flash loan execution.
8 routes · View in Swagger UI
Get the best swap quote aggregated across Uniswap, Curve, and other supported DEXes.
Execute a token swap through the optimal DEX route.
Retrieve all DeFi positions including lending deposits, staking, liquidity pools, and yield farming.
Execute a flash loan with a sequence of operations that must complete atomically.
The RegTech API provides regulatory compliance capabilities including MiFID II transaction reporting, MiCA crypto-asset compliance, Travel Rule enforcement for cross-border transfers, and jurisdiction-specific adapter configuration.
12 routes · View in Swagger UI
Submit a MiFID II transaction report to the configured National Competent Authority.
Run a MiCA compliance validation against a crypto-asset or token issuance.
Submit originator and beneficiary information for FATF Travel Rule compliance on cross-border transfers.
Get overall compliance status across all active regulatory frameworks.
The Mobile Payment API powers the FinAegis mobile wallet experience with payment intents, digital receipts, activity feeds, receive addresses, P2P transfers, passkey authentication, and biometric JWT sessions.
25+ routes · View in Swagger UI
Create a new payment intent for mobile wallet transactions.
Retrieve the mobile wallet activity feed with payments, transfers, and notifications.
Send a peer-to-peer transfer to another mobile wallet user.
Verify a FIDO2/WebAuthn passkey for passwordless mobile authentication.
The Partner BaaS (Banking-as-a-Service) API enables third-party partners to provision tenants, generate branded SDKs, configure white-label deployments, and manage their partner integrations. Requires a Partner API key (fpk_ prefix) in addition to standard authentication.
24 routes · View in Swagger UI
Provision a new tenant for a BaaS partner with isolated data and configuration.
Generate a branded SDK package for the partner's platform and language.
Update white-label branding, theming, and feature toggles for the partner deployment.
List all tenants provisioned under this partner account.
The AI Query API provides natural language access to transaction data and financial insights. Ask questions in plain English and receive structured, actionable responses.
2 routes · View in Swagger UI
Submit a natural language question about your transactions, balances, or financial activity.
Retrieve your past AI query history with cached results.
Schema-first GraphQL API powered by Lighthouse PHP. Provides queries, mutations, and subscriptions across 34 domain schemas with DataLoader-optimized resolvers and WebSocket-based real-time subscriptions.
34 domain schemas · Queries, Mutations, Subscriptions
Execute a GraphQL query or mutation against the unified schema. Supports all 34 domain schemas including Account, AgentProtocol, Basket, Batch, CardIssuance, Cgo, Compliance, CrossChain, DeFi, Exchange, FinancialInstitution, Product, Regulatory, User, Wallet, and more.
Interactive GraphQL explorer with schema introspection, auto-complete, and query history. Use this to explore available types, queries, mutations, and subscriptions.
Real-time WebSocket subscriptions are available for the following events:
accountUpdated(id: ID!) - Account balance and status changestransactionCreated(accountId: ID!) - New transactions on an accounttransferCompleted(id: ID!) - Transfer completion notificationsorderMatched(pair: String!) - Exchange order match eventsReal-time event streaming via Redis Streams with a live metrics dashboard. Monitor system health, domain status, event throughput, stream connectivity, and projector lag across all event-sourced domains.
5 endpoints · Redis Streams · Real-time Metrics
Retrieve aggregated system metrics including event counts, processing rates, error rates, and uptime statistics.
Get health status for each event-sourced domain including event store connectivity, projector status, and recent error counts.
Monitor real-time event throughput rates per domain and aggregate, including events per second and processing latency.
Check Redis Streams connectivity, consumer group status, pending message counts, and stream memory usage.
Monitor projector lag across all event-sourced domains showing how far behind each read model projector is from the latest events.
The x402 Protocol enables HTTP-native micropayments using USDC on Base. Monetize any API endpoint by returning HTTP 402 responses with payment requirements. Supports AI agent autonomous payments, spending limits, and multi-network settlement.
15+ endpoints · View in Swagger UI
Get the current x402 protocol status including supported networks, assets, and facilitator connectivity.
List all supported blockchain networks and payment assets for x402 settlement.
Register an API endpoint for x402 monetization with pricing configuration.
Retrieve payment history and settlement status for x402 transactions.
View and manage spending limits for automated x402 payments including AI agent budgets.
When a client hits a monetized endpoint without payment, it receives an HTTP 402 with payment requirements in headers:
Download the OpenAPI specification file or view it in your preferred API client.
Import the JSON file into Postman, Insomnia, or any OpenAPI-compatible tool