This endpoint reads a customer's details.

Read a customer

The country code that issued the document following ISO 3166-1 alpha-2 (BRA is the only one accepted at the moment)

The type of document (TAX_ID is the only one accepted at the moment)

apiKey

Lumx

Dashboard

System Status

Community

API Reference

Start now

Support

Welcome to the Developer Documentation for Lumx. These docs are intended for developers looking to integrate Lumx API into their platform.

Introduction

Learn how to authenticate yourself to get access to our APIs

Authentication

Multiple enviroments with multiple purposes

Environments

Choose the best blockchain to fit your project

Blockchains

Find out the common extended error messages you may encounter while using our system

Troubleshooting

APIs

Accounts

Orchestration

Read all customers

This endpoint creates a customer. At least one document is required.

Create a customer

This endpoint updates a customer's details including documents. Each field is optional, so you can update only some of the customer's details. If a document is provided, it will be updated or added to the customer's documents list.

Update a customer

Get a price quote for converting between currencies.

Get an exchange rate

Convert BRL (Brazilian Real) to USDC or USDT.

On-ramp

Convert USDC or USDT to BRL (Brazilian Real).

Off-ramp

Transfer stablecoins between customers or to an external crypto wallet.

Transfer

Execute a transaction that you previously signed using your signing provider. Important: This is an ASYNC route! Use the read transaction route to check the transaction's status.

Execute a transaction

This endpoint reads all transactions made with your API key.

Read all transactions

This endpoint reads a transaction made with your API key.

Customers

Exchange Rates

Transactions

Read a customer

Authorizations

Path Parameters

Response