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": "individual",
"name": "William Default",
"taxId": "123.456.789-00",
"birthDate": "1990-01-01",
"country": "BRA",
"email": "william.default@example.com",
"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.

The response is of type object.