Create a customer
This endpoint creates a customer.
Authorizations
Bearer authentication header on the format Bearer <API_KEY>.
Headers
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
- Business
- Individual
Customer's type.
BUSINESS Customer's legal name.
"Lumx S.A"
Customer's tax ID. It must be a valid tax ID in the country where the company is incorporated.
"42.887.120/0001-00"
Customer's incorporation date.
"2020-01-01"
Customer's country (ISO 3166-1 alpha-3).
"BRA"
Customer's email.
"hello@lumx.io"
Optional metadata object to attach to the customer. Accepts any valid JSON object.
Optional list of currencies for virtual fiat accounts to provision alongside the customer. Each provisioned account enters verification and becomes ACTIVE once approved.
BRL, USD, EUR, MXN Response
Resource successfully created.
- Business
- Individual
Customer fields returned at creation time. The wallets array is omitted because it's only available after the customer's verification.status is APPROVED.
Customer's unique identifier.
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
Customer's type.
BUSINESS Customer's legal name.
"Lumx S.A"
Customer's tax ID.
"42.887.120/0001-00"
Customer's incorporation date.
"2020-01-01"
Customer's country (ISO 3166-1 alpha-3).
"BRA"
Customer's email.
"hello@lumx.io"
Custom metadata associated with the customer. Returns an empty object if no metadata was provided.
Customer's verification.
List of document requirements for KYC/KYB verification.
Creation date and time (UTC).
"2021-01-01T00:00:00Z"
Last update date and time (UTC).
"2021-01-01T00:00:00Z"