Getting Started

Overview

The Lirium API enables you to embed crypto trading, custody, and fiat on/off-ramps into your platform, with native support for local payment rails across Latin America and Europe. This guide walks you through authentication and your first request.

Base URLs

Use the Sandbox environment for development and testing. It does not affect live data or interact with blockchain networks.

Quick Start

1. Set Up Authentication

Generate an RSA key pair for JWT authentication:

openssl genrsa -out private.pem 4096
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

Send the contents of public.pem to Lirium. You will receive an API Key in return.

2. Generate a JWT

Create a signed JWT for each API request using your private key and API Key. See JWT Generation for implementation details.

3. Make Your First Request

Include the JWT in the Authorization header:

curl -X GET "https://api.lirium-sandbox.com/v1/partner" \
  -H "Authorization: Bearer <your-jwt>" \
  -H "Content-Type: application/json"

Core Concepts

Customers

Customers represent end users in your platform. Each customer requires KYC verification before they can trade. See Customers for details.

Orders

Orders are the primary way to execute trades (buy, sell, swap, send) and manage investments. All orders follow a two-step process:

1. Create — Initialize the order and receive a quote
2. Confirm — Finalize the order with a security code

See Orders for implementation details.

Webhooks

Subscribe to real-time events for order updates, customer state changes, and incoming funds. See Webhooks for setup instructions.

Next Steps

• Authentication Setup — Complete guide to API authentication
• Customer Onboarding — End-to-end guide: create a Customer, complete KYC and place their first order
• Onboarding Flow — The same flow as runnable code
• Fiat Instructions — Fund Customers through local fiat rails
• Buy Crypto Recipe — Step-by-step guide to executing a crypto purchase
• Error Codes — Handle errors gracefully
• General Definitions — Pagination, field formats, and conventions

Support

For questions not covered in this documentation, contact [email protected].