Skip to main content
POST

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.

Body

application/json
type
enum<string>
required

Customer's type.

Available options:
BUSINESS

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 (ISO 3166-1 alpha-3).

Example:

"BRA"

email
string
required

Customer's email.

Example:

"hello@lumx.io"

metadata
object

Optional metadata object to attach to the customer. Accepts any valid JSON object.

Example:
accounts
enum<string>[]

Optional list of currencies for virtual fiat accounts to provision alongside the customer. Each provisioned account enters verification and becomes ACTIVE once approved.

Available options:
BRL,
USD,
EUR,
MXN
Example:

Response

201 - application/json

Resource successfully created.

Customer fields returned at creation time. The wallets array is omitted because it's only available after the customer's verification.status is APPROVED.

id
string<uuid>
read-only

Customer's unique identifier.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

type
enum<string>

Customer's type.

Available options:
BUSINESS

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:

"hello@lumx.io"

metadata
object

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

Example:
verification
object

Customer's verification.

requirements
object[]

List of document requirements for KYC/KYB verification.

Example:
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"