Read all customers
This endpoint reads all customers.
curl --request GET \
--url https://api-sandbox.lumx.io/customers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "individual",
"address": {
"line1": "Rua dos Bobos, 0",
"line2": "Apto 101",
"country": "BRA",
"state": "SP",
"city": "São Paulo",
"zipCode": "01234-567"
},
"documents": [
{
"country": "BRA",
"type": "TAX_ID",
"value": "123.456.789-00"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"birthdate": "1990-01-01"
}
]
}Authorizations
Bearer authentication header of the form Bearer <API_KEY>.
Response
An array containing all customers.
Unique customer identifier
The type of this customer.
individual The first line of the address
"Rua dos Bobos, 0"
The second line of the address
"Apto 101"
The country code where the customer is located following ISO 3166-1 alpha-2 (BRA is the only one accepted at the moment)
BRA "BRA"
The state where the customer is located
"SP"
The city where the customer is located
"São Paulo"
The postal code where the customer is located
"01234-567"
List of customer documents
The country code that issued the document following ISO 3166-1 alpha-2 (BRA is the only one accepted at the moment)
BRA The type of document (TAX_ID is the only one accepted at the moment)
TAX_ID The document value/number.
"123.456.789-00"
[
{
"country": "BRA",
"type": "TAX_ID",
"value": "123.456.789-00"
}
]
Record creation timestamp
Record last update timestamp
Customer full name
Customer birth date
"1990-01-01"
curl --request GET \
--url https://api-sandbox.lumx.io/customers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "individual",
"address": {
"line1": "Rua dos Bobos, 0",
"line2": "Apto 101",
"country": "BRA",
"state": "SP",
"city": "São Paulo",
"zipCode": "01234-567"
},
"documents": [
{
"country": "BRA",
"type": "TAX_ID",
"value": "123.456.789-00"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"birthdate": "1990-01-01"
}
]
}