PATCH
/
customers
/
{id}
curl --request PATCH \
  --url https://api-sandbox.lumx.io/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
    }
  ],
  "name": "<string>",
  "birthdate": "1990-01-01"
}'
{
  "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Path Parameters

​
id
string
required

The ID of the customer.

Body

application/json

Individual customer

​
type
enum<string>
required

The type of this customer.

Available options:
individual
​
address
object
​
documents
object[]

List of customer documents

Example:
[
  {
    "country": "BRA",
    "type": "TAX_ID",
    "value": "123.456.789-00"
  }
]
​
name
string

Customer full name

​
birthdate
string

Customer birth date

Example:

"1990-01-01"

Response

200
application/json
Customer updated successfully.
​
id
string

Unique customer identifier

​
type
enum<string>

The type of this customer.

Available options:
individual
​
address
object
​
documents
object[]

List of customer documents

Example:
[
  {
    "country": "BRA",
    "type": "TAX_ID",
    "value": "123.456.789-00"
  }
]
​
createdAt
string

Record creation timestamp

​
updatedAt
string

Record last update timestamp

​
name
string

Customer full name

​
birthdate
string

Customer birth date

Example:

"1990-01-01"

Previous
Get an exchange rate
Next