Read a customer

curl --request GET \
  --url https://api-sandbox.lumx.io/customers/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.lumx.io/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.lumx.io/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.lumx.io/customers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.lumx.io/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "BUSINESS",
  "legalName": "Lumx S.A",
  "taxId": "42.887.120/0001-00",
  "incorporationDate": "2020-01-01",
  "country": "BRA",
  "email": "hello@lumx.io",
  "verification": {
    "status": "NOT_STARTED",
    "level": "STANDARD",
    "link": "https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"
  },
  "additionalInformation": {
    "type": "BUSINESS",
    "businessActivity": "PAYMENT_INSTITUTION",
    "servicesProvided": "We provide blockchain-based payment infrastructure for B2B cross-border transactions.",
    "monthlyRevenueInUSD": "250000",
    "monthlyTransactionVolumeInUSD": "1M_TO_5M",
    "sourceOfFunds": "OPERATING_SERVICE_REVENUE",
    "transactionCounterparties": [
      "CUSTOMERS",
      "SUPPLIERS_VENDORS"
    ],
    "isRegulatedActivity": true,
    "regulatedActivityDetails": "Licensed payment institution"
  },
  "accounts": [
    {
      "id": "d06d342c-629a-4d99-a26f-34e8ea528403",
      "currency": "EUR"
    },
    {
      "id": "af04e979-360a-428a-84e6-cbd8ffc4942b",
      "currency": "USD"
    },
    {
      "id": "8412f484-32fe-418f-80d1-99eb1b3ba7f3",
      "currency": "BRL"
    }
  ],
  "transactionLimits": {
    "onramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "1200.00",
        "remaining": "3800.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "1200.00",
        "remaining": "18800.00"
      }
    },
    "offramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    },
    "transfer": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    }
  },
  "metadata": {},
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

GET

customers

{id}

Read a customer

curl --request GET \
  --url https://api-sandbox.lumx.io/customers/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.lumx.io/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.lumx.io/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.lumx.io/customers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.lumx.io/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "BUSINESS",
  "legalName": "Lumx S.A",
  "taxId": "42.887.120/0001-00",
  "incorporationDate": "2020-01-01",
  "country": "BRA",
  "email": "hello@lumx.io",
  "verification": {
    "status": "NOT_STARTED",
    "level": "STANDARD",
    "link": "https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"
  },
  "additionalInformation": {
    "type": "BUSINESS",
    "businessActivity": "PAYMENT_INSTITUTION",
    "servicesProvided": "We provide blockchain-based payment infrastructure for B2B cross-border transactions.",
    "monthlyRevenueInUSD": "250000",
    "monthlyTransactionVolumeInUSD": "1M_TO_5M",
    "sourceOfFunds": "OPERATING_SERVICE_REVENUE",
    "transactionCounterparties": [
      "CUSTOMERS",
      "SUPPLIERS_VENDORS"
    ],
    "isRegulatedActivity": true,
    "regulatedActivityDetails": "Licensed payment institution"
  },
  "accounts": [
    {
      "id": "d06d342c-629a-4d99-a26f-34e8ea528403",
      "currency": "EUR"
    },
    {
      "id": "af04e979-360a-428a-84e6-cbd8ffc4942b",
      "currency": "USD"
    },
    {
      "id": "8412f484-32fe-418f-80d1-99eb1b3ba7f3",
      "currency": "BRL"
    }
  ],
  "transactionLimits": {
    "onramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "1200.00",
        "remaining": "3800.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "1200.00",
        "remaining": "18800.00"
      }
    },
    "offramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    },
    "transfer": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    }
  },
  "metadata": {},
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header on the format Bearer <API_KEY>.

Path Parameters

string<uuid>

required

Customer's unique identifier.

Query Parameters

includeBalances

boolean

Whether to include balances in the response body.

includeTransactionLimits

boolean

Whether to include transaction limits in the response body. Limits are returned per transaction type (onramp, offramp and transfer).

Response

200 - application/json

Resource successfully retrieved.

Business
Individual

string<uuid>

read-only

Customer's unique identifier.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

type

enum<string>

Customer's type.

Available options:

BUSINESS

legalName

string

Customer's legal name.

Example:

"Lumx S.A"

taxId

string

Customer's tax ID.

Example:

"42.887.120/0001-00"

incorporationDate

string<date>

Customer's incorporation date.

Example:

"2020-01-01"

country

string

Customer's country (ISO 3166-1 alpha-3).

Example:

"BRA"

string

Customer's email.

Example:

"hello@lumx.io"

metadata

object

Custom metadata associated with the customer. Returns an empty object if no metadata was provided.

Example:

{
  "externalId": "usr_123",
  "tier": "premium"
}

wallets

object[]

Customer's wallets by blockchain. Only returned when the customer's verification.status is APPROVED.

Show child attributes

verification

object

Customer's verification.

Show child attributes

requirements

object[]

List of document requirements for KYC/KYB verification.

Show child attributes

Example:

[
  { "name": "ID_CARD", "status": "NOT_SENT" },
  { "name": "PASSPORT", "status": "NOT_SENT" },
  {
    "name": "BANK_STATEMENT",
    "status": "NOT_SENT"
  }
]

additionalInformation

Individual (current questionnaire) · object

Additional information submitted for KYC/KYB verification. Only present after sending additional information. Returns what the customer answered, except phone, the names, address and website: the current questionnaire, or the previous questionnaire for customers created before October 28, 2026.

Individual (current questionnaire)
Business (current questionnaire)
Individual (previous questionnaire, customers created before October 28, 2026)
Business (previous questionnaire, customers created before October 28, 2026)

Show child attributes

accounts

object[]

Virtual fiat accounts linked to the customer for receiving payments. Optional—only present when the customer has at least one account. Each entry exposes the account's id and currency.

Show child attributes

transactionLimits

object

Customer's transaction limits per transaction type. Only returned when includeTransactionLimits is true. Each transaction type consumes only its own limit: on-ramps count against onramp, off-ramps against offramp and transfers against transfer. A transaction over its type's limit returns 422 with code TRANSACTION_LIMIT_EXCEEDED, and the error message names the transaction type and the limit it would pass.

Show child attributes

createdAt

string<date-time>

Creation date and time (UTC).

Example:

"2021-01-01T00:00:00Z"

updatedAt

string<date-time>

Last update date and time (UTC).

Example:

"2021-01-01T00:00:00Z"

Customers

Accounts

Destinations

Exchange Rates

Transactions

Partner Fees

Autoconversion Rules

Read a customer

Authorizations

Path Parameters

Query Parameters

Response