Skip to main content
GET
/
customers
/
{id}
Read a customer
curl --request GET \
  --url https://api.lumx.io/customers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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",
    "phone": "+5511999999999",
    "address": {
      "country": "BRA",
      "line1": "Av. Paulista, 1000, Sala 101",
      "city": "São Paulo",
      "state": "SP",
      "postalCode": "01310-100"
    },
    "monthlyVolumeInUSD": "50000.00",
    "transactionVolumeInUSD": "10000.00",
    "jurisdictions": [
      "BRA",
      "USA",
      "EU"
    ],
    "involvedActivities": [
      "NONE"
    ],
    "transactionCounterparties": [
      "SELF"
    ],
    "companyType": "BLOCKCHAIN_SOFTWARE_COMPANY",
    "annualRevenue": "1000000.00",
    "monthlyTransactionVolume": "100000.00",
    "complianceAndAML": "We have a dedicated compliance team and use third-party AML screening tools.",
    "isRegulatedActivity": false,
    "regulatedActivityDetails": "",
    "website": "https://example.com",
    "sourceOfFunds": "COMPANY",
    "servicesProvided": "We provide blockchain-based payment infrastructure for B2B cross-border transactions."
  },
  "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": {
    "single": {
      "max": "10000.00"
    },
    "daily": {
      "max": "100000.00",
      "used": "0.00",
      "remaining": "100000.00"
    },
    "monthly": {
      "max": "1000000.00",
      "used": "0.00",
      "remaining": "1000000.00"
    }
  },
  "metadata": {},
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lumx.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Path Parameters

​
id
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.

Response

200 - application/json

Resource successfully retrieved.

​
id
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"

​
email
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.

​
verification
object

Customer's verification.

​
requirements
object[]

List of document requirements for KYC/KYB verification.

Example:
[
  { "name": "ID_CARD", "status": "NOT_SENT" },
  { "name": "PASSPORT", "status": "NOT_SENT" },
  {
    "name": "BANK_STATEMENT",
    "status": "NOT_SENT"
  }
]
​
additionalInformation
object

Additional information submitted for KYC/KYB verification. Only present after sending additional information.

​
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.

​
transactionLimits
object

Customer's transaction limits.

​
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"