Skip to main content
POST
/
customers
Create a customer
curl --request POST \
  --url https://api.lumx.io/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "business",
  "legalName": "Lumx S.A",
  "taxId": "42.887.120/0001-00",
  "incorporationDate": "2020-01-01",
  "country": "BRA",
  "email": "hello@lumx.io"
}'
{
  "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",
  "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>.

Body

application/json
​
type
enum<string>
required

Customer's type.

Available options:
business
​
legalName
string
required

Customer's legal name.

Example:

"Lumx S.A"

​
taxId
string
required

Customer's tax ID. It must be a valid tax ID in the country where the company is incorporated.

Example:

"42.887.120/0001-00"

​
incorporationDate
string<date>
required

Customer's incorporation date.

Example:

"2020-01-01"

​
country
string
required

Customer's country using ISO 3166-1 alpha-3 code.

Example:

"BRA"

​
email
string
required

Customer's email.

Example:

"hello@lumx.io"

Response

201 - application/json

Resource successfully created.

​
id
string<uuid>

Customer's unique identifier.

​
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. It must be a valid tax ID in the country where the company is incorporated.

Example:

"42.887.120/0001-00"

​
incorporationDate
string<date>

Customer's incorporation date.

Example:

"2020-01-01"

​
country
string

Customer's country using ISO 3166-1 alpha-3 code.

Example:

"BRA"

​
email
string

Customer's email.

Example:

"hello@lumx.io"

​
walletAddress
string

Customer's wallet address.

Example:

"0x1234567890123456789012345678901234567890"

​
blockExplorerUrl
string

Customer's block explorer URL.

Example:

"https://amoy.polygonscan.com/address/0x1234567890123456789012345678901234567890"

​
verification
object

Customer's verification KYC/KYB.

​
transactionLimits
object

Verification'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"

⌘I