Skip to main content
PATCH
/
customers
/
{id}
curl --request PATCH \
  --url https://api.lumx.io/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'
{
  "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]",
  "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."
  },
  "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"
    }
  },
  "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>.

Headers

​
Idempotency-Key
string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Path Parameters

​
id
string<uuid>
required

Customer's unique identifier.

Body

application/json
​
type
enum<string>
required

Customer type.

Available options:
INDIVIDUAL
​
phone
string
required

Phone number in international format.

Example:

"+5511999999999"

​
firstName
string
required

Customer's first name.

Example:

"William"

​
middleName
string
required

Customer's middle name.

Example:

""

​
lastName
string
required

Customer's last name.

Example:

"Default"

​
address
object
required

Address information.

​
monthlyVolumeInUSD
string
required

Expected monthly volume in USD.

Example:

"5000"

​
transactionVolumeInUSD
string
required

Expected volume per transaction in USD.

Example:

"1000"

​
jurisdictions
enum<string>[]
required

Regions where transactions will occur.

Available options:
BRA,
USA,
EU,
CANADA,
CHINA,
MEXICO,
OTHERS
Example:
["BRA", "USA"]
​
involvedActivities
enum<string>[]
required

Activities involved.

Available options:
NONE,
ADULT_ENTERTAINMENT,
DRUGS,
FIREARMS,
GAMBLING,
MARIJUANA,
TUMBLING
Example:
["NONE"]
​
transactionCounterparties
enum<string>[]
required

Transaction counterparties.

Available options:
SELF,
MERCHANTS_SUPPLIERS,
CUSTOMERS,
EMPLOYEES,
CONTRACTORS,
FRIENDS,
FAMILY
Example:
["SELF", "MERCHANTS_SUPPLIERS"]
​
professionalSituation
enum<string>
required

Professional situation.

Available options:
EMPLOYEE,
SELF_EMPLOYED,
UNEMPLOYED,
RETIRED,
OTHER
Example:

"EMPLOYEE"

​
professionalOccupation
string
required

Professional occupation description.

Example:

"Software Engineer"

​
sourceOfFunds
enum<string>
required

Source of funds.

Available options:
EMPLOYMENT,
SAVINGS,
WINNINGS,
MARITAL,
REAL_ESTATE,
TRUST,
INVESTMENT,
OTHER,
COMPANY,
COMPANY_CAPITAL,
LOAN,
PRIVATE_CAPITAL,
GRANT
Example:

"EMPLOYMENT"

Response

200 - application/json

Resource successfully updated.

​
id
string<uuid>

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:

"[email protected]"

​
wallets
object[]

Customer's wallets by blockchain.

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

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