Read all customers

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

{
  "data": [
    {
      "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": "[email protected]",
      "walletAddress": "0x1234567890123456789012345678901234567890",
      "blockExplorerUrl": "https://amoy.polygonscan.com/address/0x1234567890123456789012345678901234567890",
      "verification": {
        "status": "NOT_STARTED",
        "level": "STANDARD",
        "link": "https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"
      },
      "transactionLimits": {
        "single": "1000.00",
        "daily": "10000.00",
        "monthly": "100000.00"
      },
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z"
    }
  ]
}

GET

customers

Read all customers

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

{
  "data": [
    {
      "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": "[email protected]",
      "walletAddress": "0x1234567890123456789012345678901234567890",
      "blockExplorerUrl": "https://amoy.polygonscan.com/address/0x1234567890123456789012345678901234567890",
      "verification": {
        "status": "NOT_STARTED",
        "level": "STANDARD",
        "link": "https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"
      },
      "transactionLimits": {
        "single": "1000.00",
        "daily": "10000.00",
        "monthly": "100000.00"
      },
      "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>.

Query Parameters

size

integer

default:25

Number of customers to return per page.

Required range: 1 <= x <= 100

cursor

string<uuid>

Cursor for pagination. Use the nextCursor or previousCursor from the previous response to get the next or previous page.

Response

200 - application/json

Resources successfully retrieved.

data

object[]

An array containing all customers.

Show child attributes

data.id

string<uuid>

Customer's unique identifier.

Example:

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

data.type

enum<string>

Customer's type.

Available options:

BUSINESS

data.legalName

string

Customer's legal name.

Example:

"Lumx S.A"

data.taxId

string

Customer's tax ID.

Example:

"42.887.120/0001-00"

data.incorporationDate

string<date>

Customer's incorporation date.

Example:

"2020-01-01"

data.country

string

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

Example:

"BRA"

data.email

string

Customer's email.

Example:

"[email protected]"

data.walletAddress

string

Customer's wallet address.

Example:

"0x1234567890123456789012345678901234567890"

data.blockExplorerUrl

string

Customer's wallet block explorer URL.

Example:

"https://amoy.polygonscan.com/address/0x1234567890123456789012345678901234567890"

data.verification

object

Customer's verification.

Show child attributes

data.verification.status

enum<string>

Verification status.

Available options:

NOT_STARTED,

UNDER_VERIFICATION,

APPROVED,

TEMPORARY_REJECTION,

FINAL_REJECTION

Example:

"NOT_STARTED"

data.verification.level

enum<string>

Verification level.

Available options:

STANDARD

Example:

"STANDARD"

data.verification.link

string

Verification link.

Example:

"https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"

data.transactionLimits

object

Customer's transaction limits.

Show child attributes

data.transactionLimits.single

string

Single transaction limit for the customer.

Example:

"1000.00"

data.transactionLimits.daily

string

Daily limit for the customer.

Example:

"10000.00"

data.transactionLimits.monthly

string

Monthly limit for the customer.

Example:

"100000.00"

data.createdAt

string<date-time>

Creation date and time (UTC).

Example:

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

data.updatedAt

string<date-time>

Last update date and time (UTC).

Example:

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

Create a customer

⌘I

Customers

Bank Accounts

Exchange Rates

Transactions

Partner Fees

Read all customers

Authorizations

Query Parameters

Response