Send additional information

curl --request PATCH \
  --url https://api-sandbox.lumx.io/customers/{id}/additional-information \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "BUSINESS",
  "phone": "+5511999999999",
  "address": {
    "country": "BRA",
    "line1": "Av. B, 200",
    "city": "São Paulo",
    "state": "SP",
    "postalCode": "01000-000"
  },
  "website": "https://acme.com",
  "businessActivity": "PAYMENT_INSTITUTION",
  "servicesProvided": "Cross-border payments for small businesses",
  "monthlyRevenueInUSD": "250000",
  "monthlyTransactionVolumeInUSD": "1M_TO_5M",
  "sourceOfFunds": "OPERATING_SERVICE_REVENUE",
  "transactionCounterparties": [
    "CUSTOMERS",
    "SUPPLIERS_VENDORS"
  ],
  "isRegulatedActivity": true,
  "regulatedActivityDetails": "Licensed payment institution"
}
'

{
  "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": "hello@lumx.io",
  "verification": {
    "status": "NOT_STARTED",
    "level": "STANDARD",
    "link": "https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"
  },
  "additionalInformation": {
    "type": "BUSINESS",
    "businessActivity": "PAYMENT_INSTITUTION",
    "servicesProvided": "We provide blockchain-based payment infrastructure for B2B cross-border transactions.",
    "monthlyRevenueInUSD": "250000",
    "monthlyTransactionVolumeInUSD": "1M_TO_5M",
    "sourceOfFunds": "OPERATING_SERVICE_REVENUE",
    "transactionCounterparties": [
      "CUSTOMERS",
      "SUPPLIERS_VENDORS"
    ],
    "isRegulatedActivity": true,
    "regulatedActivityDetails": "Licensed payment institution"
  },
  "accounts": [
    {
      "id": "d06d342c-629a-4d99-a26f-34e8ea528403",
      "currency": "EUR"
    },
    {
      "id": "af04e979-360a-428a-84e6-cbd8ffc4942b",
      "currency": "USD"
    },
    {
      "id": "8412f484-32fe-418f-80d1-99eb1b3ba7f3",
      "currency": "BRL"
    }
  ],
  "transactionLimits": {
    "onramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "1200.00",
        "remaining": "3800.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "1200.00",
        "remaining": "18800.00"
      }
    },
    "offramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    },
    "transfer": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    }
  },
  "metadata": {},
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

PATCH

customers

{id}

additional-information

curl --request PATCH \
  --url https://api-sandbox.lumx.io/customers/{id}/additional-information \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "BUSINESS",
  "phone": "+5511999999999",
  "address": {
    "country": "BRA",
    "line1": "Av. B, 200",
    "city": "São Paulo",
    "state": "SP",
    "postalCode": "01000-000"
  },
  "website": "https://acme.com",
  "businessActivity": "PAYMENT_INSTITUTION",
  "servicesProvided": "Cross-border payments for small businesses",
  "monthlyRevenueInUSD": "250000",
  "monthlyTransactionVolumeInUSD": "1M_TO_5M",
  "sourceOfFunds": "OPERATING_SERVICE_REVENUE",
  "transactionCounterparties": [
    "CUSTOMERS",
    "SUPPLIERS_VENDORS"
  ],
  "isRegulatedActivity": true,
  "regulatedActivityDetails": "Licensed payment institution"
}
'

{
  "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": "hello@lumx.io",
  "verification": {
    "status": "NOT_STARTED",
    "level": "STANDARD",
    "link": "https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"
  },
  "additionalInformation": {
    "type": "BUSINESS",
    "businessActivity": "PAYMENT_INSTITUTION",
    "servicesProvided": "We provide blockchain-based payment infrastructure for B2B cross-border transactions.",
    "monthlyRevenueInUSD": "250000",
    "monthlyTransactionVolumeInUSD": "1M_TO_5M",
    "sourceOfFunds": "OPERATING_SERVICE_REVENUE",
    "transactionCounterparties": [
      "CUSTOMERS",
      "SUPPLIERS_VENDORS"
    ],
    "isRegulatedActivity": true,
    "regulatedActivityDetails": "Licensed payment institution"
  },
  "accounts": [
    {
      "id": "d06d342c-629a-4d99-a26f-34e8ea528403",
      "currency": "EUR"
    },
    {
      "id": "af04e979-360a-428a-84e6-cbd8ffc4942b",
      "currency": "USD"
    },
    {
      "id": "8412f484-32fe-418f-80d1-99eb1b3ba7f3",
      "currency": "BRL"
    }
  ],
  "transactionLimits": {
    "onramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "1200.00",
        "remaining": "3800.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "1200.00",
        "remaining": "18800.00"
      }
    },
    "offramp": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    },
    "transfer": {
      "single": {
        "max": "1000.00"
      },
      "daily": {
        "max": "5000.00",
        "used": "0.00",
        "remaining": "5000.00"
      },
      "monthly": {
        "max": "20000.00",
        "used": "0.00",
        "remaining": "20000.00"
      }
    }
  },
  "metadata": {},
  "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

string<uuid>

required

Customer's unique identifier.

Body

application/json

Individual (current questionnaire)
Business (current questionnaire)
Individual (previous questionnaire, customers created before October 28, 2026)
Business (previous questionnaire, customers created before October 28, 2026)

Body for individual customers created on or after October 28, 2026.

type

enum<string>

required

Customer type.

Available options:

INDIVIDUAL

phone

string

required

Phone number in international format.

Example:

"+5511999999999"

address

object

required

Address information.

Show child attributes

firstName

string

required

Customer's first name.

Example:

"Maria"

lastName

string

required

Customer's last name.

Example:

"Souza"

monthlyIncomeInUSD

string

required

Monthly income in USD, as a non-negative amount with at most 18 integer digits and two decimals.

Pattern: ^\d{1,18}(\.\d{1,2})?$

Example:

"8000"

monthlyVolumeInUSD

string

required

Expected monthly volume in USD.

Example:

"5000"

transactionVolumeInUSD

string

required

Expected volume per transaction in USD.

Example:

"1000"

professionalSituation

enum<string>

required

Professional situation.

Available options:

EMPLOYEE,

SELF_EMPLOYED,

BUSINESS_OWNER,

GOVERNMENT_OFFICIAL,

INVESTOR,

STUDENT,

RETIRED,

HOMEMAKER,

UNEMPLOYED,

OTHER

Example:

"BUSINESS_OWNER"

professionalOccupation

string

required

Professional occupation description.

Example:

"Engineer"

sourceOfFunds

enum<string>

required

Source of funds.

Available options:

SALARY_EMPLOYMENT_INCOME,

BUSINESS_INCOME_DIVIDENDS,

SAVINGS_INVESTMENT_RETURNS,

PENSION_RETIREMENT,

SALE_OF_ASSETS_REAL_ESTATE,

INHERITANCE_GIFT,

LOAN,

GOVERNMENT_BENEFITS,

GAMBLING_LOTTERY_PROCEEDS,

ROYALTIES_INTELLECTUAL_PROPERTY,

THIRD_PARTY_FUNDS,

OTHER

Example:

"SALARY_EMPLOYMENT_INCOME"

transactionCounterparties

enum<string>[]

required

Transaction counterparties.

Minimum array length: 1

Available options:

SELF,

FAMILY,

FRIENDS,

EMPLOYER,

MERCHANTS_BUSINESSES,

GOVERNMENT,

OTHER

Example:

["SELF", "FAMILY"]

middleName

string

Customer's middle name.

Example:

"Silva"

Response

200 - application/json

Resource successfully updated.

Business
Individual

string<uuid>

read-only

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"

string

Customer's email.

Example:

"hello@lumx.io"

metadata

object

Custom metadata associated with the customer. Returns an empty object if no metadata was provided.

Example:

{
  "externalId": "usr_123",
  "tier": "premium"
}

wallets

object[]

Customer's wallets by blockchain. Only returned when the customer's verification.status is APPROVED.

Show child attributes

verification

object

Customer's verification.

Show child attributes

requirements

object[]

List of document requirements for KYC/KYB verification.

Show child attributes

Example:

[
  { "name": "ID_CARD", "status": "NOT_SENT" },
  { "name": "PASSPORT", "status": "NOT_SENT" },
  {
    "name": "BANK_STATEMENT",
    "status": "NOT_SENT"
  }
]

additionalInformation

Individual (current questionnaire) · object

Additional information submitted for KYC/KYB verification. Only present after sending additional information. Returns what the customer answered, except phone, the names, address and website: the current questionnaire, or the previous questionnaire for customers created before October 28, 2026.

Individual (current questionnaire)
Business (current questionnaire)
Individual (previous questionnaire, customers created before October 28, 2026)
Business (previous questionnaire, customers created before October 28, 2026)

Show child attributes

accounts

object[]

Virtual fiat accounts linked to the customer for receiving payments. Optional—only present when the customer has at least one account. Each entry exposes the account's id and currency.

Show child attributes

transactionLimits

object

Customer's transaction limits per transaction type. Only returned when includeTransactionLimits is true. Each transaction type consumes only its own limit: on-ramps count against onramp, off-ramps against offramp and transfers against transfer. A transaction over its type's limit returns 422 with code TRANSACTION_LIMIT_EXCEEDED, and the error message names the transaction type and the limit it would pass.

Show child attributes

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"

Customers

Accounts

Destinations

Exchange Rates

Transactions

Partner Fees

Autoconversion Rules

Send additional information

Authorizations

Headers

Path Parameters

Body

Response