# Lumx

## Docs

- [Welcome](https://docs.lumx.io/get-started/welcome.md): Stablecoin infrastructure for global payments, treasury, and payouts
- [Authentication](https://docs.lumx.io/get-started/authentication.md): Get your authentication credentials to start sending requests.
- [Environments](https://docs.lumx.io/get-started/environments.md): Sandbox and production base URLs
- [Coverage](https://docs.lumx.io/get-started/coverage.md): Explore payment rails and supported pairs
- [Customers](https://docs.lumx.io/concepts/customers.md): Understand customer entities and verification workflows
- [Stablecoin Wallets](https://docs.lumx.io/concepts/wallets.md): Hold stablecoin balances and trigger payouts in a single API call
- [Accounts](https://docs.lumx.io/concepts/accounts.md): Send and receive fiat with virtual accounts tied to a customer
- [Destinations](https://docs.lumx.io/concepts/destinations.md): Configure destinations and holder relationships for payouts
- [Exchange Rates](https://docs.lumx.io/concepts/exchange-rates.md): Understand floating and locked exchange rates for currency conversions
- [Partner Fees](https://docs.lumx.io/concepts/partner-fees.md): Earn revenue by adding fees to transactions processed through Lumx
- [Transactions](https://docs.lumx.io/concepts/transactions.md): Understand transaction types and lifecycle for moving funds
- [Terms of Service](https://docs.lumx.io/compliance/terms-of-service.md): How customers accept Lumx's terms of service before verification
- [Identity Verification](https://docs.lumx.io/compliance/identity-verification.md): Required data for KYC/B verification processes
- [Request for Information](https://docs.lumx.io/compliance/rfi.md): Respond to additional information requests during verification
- [Source of Funds and Wealth](https://docs.lumx.io/compliance/source-of-funds.md): Documentation Lumx accepts to verify where a customer's funds and wealth come from
- [Proof of Address](https://docs.lumx.io/compliance/proof-of-address.md): Documents Lumx accepts to verify business and individual addresses
- [Transaction Limits](https://docs.lumx.io/compliance/transaction-limits.md): Understand transaction thresholds and how to request higher limits
- [Supported countries](https://docs.lumx.io/compliance/supported-countries.md): Where Lumx operates, where Enhanced Due Diligence applies, and where onboarding is restricted
- [Prohibited business activities](https://docs.lumx.io/compliance/prohibited-activities.md): High-risk and prohibited industries under Lumx's AML/CFT, sanctions, and partner-bank policies
- [Nested Payments](https://docs.lumx.io/compliance/nested-payments.md): Visibility rules for processing payments through Lumx
- [Legal Documents](https://docs.lumx.io/compliance/legal-documents.md): Terms, policies, and legal requirements for using Lumx services
- [Webhooks](https://docs.lumx.io/developer/webhooks.md): Receive real-time notifications when resource statuses change
- [Idempotency](https://docs.lumx.io/developer/idempotency.md): Prevent duplicate operations with idempotency keys
- [Errors](https://docs.lumx.io/developer/errors.md): Error response format and the full catalog of API error codes
- [OpenAPI Specification](https://docs.lumx.io/developer/openapi.md): Download the Lumx API specification for use in your tools and workflows
- [MCP Server](https://docs.lumx.io/developer/mcp-server.md): Connect AI tools to the Lumx documentation using the Model Context Protocol
- [Payment rail cut-off times](https://docs.lumx.io/additional-information/sla-and-cutoffs.md): Daily deadlines and settlement windows for each supported payment rail
- [Sender of Record](https://docs.lumx.io/additional-information/sender-of-record.md): Who appears as the sender on the recipient's bank statement
- [Company Types](https://docs.lumx.io/additional-information/company-types.md): Business categories collected on the companyType field during KYB onboarding
- [Purpose Codes](https://docs.lumx.io/additional-information/purpose-codes.md): Transaction purpose values accepted on on-ramp and off-ramp requests
- [Document Types](https://docs.lumx.io/additional-information/document-types.md): Accepted document types for KYC and KYB verification uploads
- [Onboarding Fields](https://docs.lumx.io/additional-information/onboarding-fields.md): Self-disclosure enums collected on customer creation and additional information requests
- [Tax IDs by Country](https://docs.lumx.io/additional-information/tax-ids-by-country.md): Identification numbers accepted in the taxId field for individual customers by country of residence
- [Global accounts](https://docs.lumx.io/guides/use-cases/global-accounts.md): Provision local-currency accounts so each customer can be paid worldwide
- [Payroll](https://docs.lumx.io/guides/use-cases/payroll.md): Run global payroll by funding employers in stablecoin and paying employees in local fiat
- [Treasury management](https://docs.lumx.io/guides/use-cases/treasury-management.md): Hold working capital in stablecoin, sweep funds between entities, and settle to local fiat on demand
- [Remittances](https://docs.lumx.io/guides/use-cases/remittances.md): Send money cross-border by funding senders in local currency and paying recipients on local rails
- [Marketplaces](https://docs.lumx.io/guides/use-cases/marketplaces.md): Take a platform fee on every sale and settle sellers anywhere in their local currency
- [Create a Customer](https://docs.lumx.io/guides/create-a-customer.md): Register individual and business customers on the Lumx platform
- [Individual Verification (KYC)](https://docs.lumx.io/guides/individual-verification.md): Complete identity verification for individual customers
- [Business Verification (KYB)](https://docs.lumx.io/guides/business-verification.md): Complete identity verification for business customers
- [KYC Reuse](https://docs.lumx.io/guides/kyc-reuse.md): Reuse an existing Sumsub verification to onboard customers without repeating KYC
- [Autoconversion Rules](https://docs.lumx.io/guides/autoconversion-rules.md): Automatically convert incoming fiat deposits to stablecoin with a standing rule
- [Ship with AI](https://docs.lumx.io/guides/build-with-ai/overview.md): Ship stablecoin payments in apps built with AI coding tools and agents. Lumx drops into any builder through copy-paste prompts, a docs MCP server, and a REST API.
- [Build with Lovable](https://docs.lumx.io/guides/build-with-ai/lovable.md): Add cross-border payments to your Lovable app: customer onboarding, on-ramp deposits, and transaction tracking via the Lumx API and a copy-paste prompt.
- [Build with Cursor](https://docs.lumx.io/guides/build-with-ai/cursor.md): Wire Lumx into any project from Cursor: customer onboarding, on-ramp deposits, and transactions via the docs MCP server and a copy-paste prompt.
- [Build with Claude Code](https://docs.lumx.io/guides/build-with-ai/claude-code.md): Drop a Lumx integration into any codebase from the terminal: customer onboarding, on-ramp deposits, and transactions via the docs MCP server and a copy-paste prompt.
- [Build with Codex](https://docs.lumx.io/guides/build-with-ai/codex.md): Add a Lumx integration to any codebase with OpenAI Codex: customer onboarding, on-ramp deposits, and transactions via the docs MCP server and a copy-paste prompt.
- [Build with v0](https://docs.lumx.io/guides/build-with-ai/v0.md): Generate a Lumx-powered Next.js app from v0: customer onboarding, on-ramp deposits, and transactions with server actions, Vercel env vars, and a copy-paste prompt.
- [Build with Bolt.new](https://docs.lumx.io/guides/build-with-ai/bolt.md): Scaffold a Lumx integration in Bolt.new: customer onboarding, on-ramp deposits, and transactions via the Lumx API and a copy-paste prompt — with your key kept server-side.
- [Build with Replit](https://docs.lumx.io/guides/build-with-ai/replit.md): Ship a Lumx-powered app from Replit Agent: customer onboarding, on-ramp deposits, and transactions with Replit Secrets and a copy-paste prompt.
- [Read all customers](https://docs.lumx.io/api-reference/customers/read-all-customers.md): This endpoint reads all customers.
- [Create a customer](https://docs.lumx.io/api-reference/customers/create-a-customer.md): This endpoint creates a customer.
- [Read a customer](https://docs.lumx.io/api-reference/customers/read-a-customer.md): This endpoint reads a customer.
- [Create TOS acceptance link](https://docs.lumx.io/api-reference/customers/create-tos-acceptance-link.md): This endpoint generates a terms of service acceptance URL for a customer.
- [Send additional information](https://docs.lumx.io/api-reference/customers/send-additional-information.md): This endpoint updates a customer with additional information required for KYC/KYB verification.
- [Read a verification](https://docs.lumx.io/api-reference/customers/read-a-verification.md): This endpoint reads a customer's verification process.
- [Start a verification](https://docs.lumx.io/api-reference/customers/start-a-verification.md): This endpoint starts a customer's verification process. For BUSINESS customers, ensure all documents and associated parties are uploaded before starting verification. For INDIVIDUAL customers, verification starts automatically after liveness check.
- [Upload a document](https://docs.lumx.io/api-reference/customers/upload-a-document.md): This endpoint uploads a document for a customer's verification.
- [Read all associated parties](https://docs.lumx.io/api-reference/customers/read-all-associated-parties.md): This endpoint reads all associated parties of a business customer.
- [Create an associated party](https://docs.lumx.io/api-reference/customers/create-an-associated-party.md): This endpoint creates an associated party (UBO, shareholder, or representative) for a business customer.
- [Read an associated party](https://docs.lumx.io/api-reference/customers/read-an-associated-party.md): This endpoint reads an associated party of a business customer.
- [Read all accounts](https://docs.lumx.io/api-reference/accounts/read-all-accounts.md): This endpoint reads all accounts.
- [Read all destinations](https://docs.lumx.io/api-reference/destinations/read-all-destinations.md): This endpoint reads all destinations.
- [Create a destination](https://docs.lumx.io/api-reference/destinations/create-a-destination.md): This endpoint creates a destination.
- [Read a destination](https://docs.lumx.io/api-reference/destinations/read-a-destination.md): This endpoint reads a destination.
- [Get an exchange rate](https://docs.lumx.io/api-reference/exchange-rates/get-an-exchange-rate.md): This endpoint returns an exchange rate quote between two currencies.
- [Read all transactions](https://docs.lumx.io/api-reference/transactions/read-all-transactions.md): This endpoint reads all transactions.
- [Read a transaction](https://docs.lumx.io/api-reference/transactions/read-a-transaction.md): This endpoint reads a transaction.
- [On-ramp](https://docs.lumx.io/api-reference/transactions/on-ramp.md): This endpoint converts fiat to stablecoin.
- [Off-ramp](https://docs.lumx.io/api-reference/transactions/off-ramp.md): This endpoint converts stablecoins to fiat.
- [Transfer](https://docs.lumx.io/api-reference/transactions/transfer.md): This endpoint starts a transfer of funds between customers or external wallets.
- [Read all partner fees](https://docs.lumx.io/api-reference/partner-fees/read-all-partner-fees.md): This endpoint reads all partner fees.
- [Create a partner fee](https://docs.lumx.io/api-reference/partner-fees/create-a-partner-fee.md): This endpoint creates a partner fee.
- [Read a partner fee](https://docs.lumx.io/api-reference/partner-fees/read-a-partner-fee.md): This endpoint reads a partner fee.
- [Read all autoconversion rules](https://docs.lumx.io/api-reference/autoconversion-rules/read-all-autoconversion-rules.md): This endpoint reads all autoconversion rules, newest first.
- [Create an autoconversion rule](https://docs.lumx.io/api-reference/autoconversion-rules/create-an-autoconversion-rule.md): This endpoint creates an autoconversion rule. Every fiat deposit matched by the rule is automatically converted to the target asset and delivered on-chain.
- [Read an autoconversion rule](https://docs.lumx.io/api-reference/autoconversion-rules/read-an-autoconversion-rule.md): This endpoint reads an autoconversion rule, including its deposit details.
- [Simulate a deposit](https://docs.lumx.io/api-reference/autoconversion-rules/simulate-a-deposit.md): This endpoint simulates a deposit to test autoconversion rules end-to-end. Sandbox only — returns 404 in production.
- [Changelog](https://docs.lumx.io/changelog.md): Stay up to date with the latest updates and improvements to Lumx

## OpenAPI Specs

- [api-staging](https://docs.lumx.io/openapi/api-staging.yaml)
- [api-production](https://docs.lumx.io/openapi/api-production.yaml)
- [openapi](https://docs.lumx.io/api-reference/openapi.json)