Skip to main content
POST
/
customers
/
{id}
/
documents
Upload a document
curl --request POST \
  --url https://api.lumx.io/customers/{id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form type=ID_CARD \
  --form country=BRA \
  --form side=FRONT_SIDE \
  --form associatedPartyId=a1b2c3d4-e5f6-7890-abcd-ef1234567890

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

multipart/form-data
​
file
file
required

Document file to be uploaded. Maximum size is 50MB. Accepts images (JPG, PNG) and PDF.

​
type
enum<string>
required

Document type.

Available options:
ID_CARD,
PASSPORT,
DRIVERS_LICENSE,
BANK_STATEMENT,
INCOME_TAX_RETURN,
DELIVERY_RECEIPT,
SELFIE,
INCORPORATION_ARTICLES,
SHAREHOLDER_REGISTRY,
DIRECTORS_REGISTRY,
POWER_OF_ATTORNEY,
REGULATED_ACTIVITY_DOCUMENT,
SIGNED_BALANCE_SHEET,
SIGNED_CORPORATE_STRUCTURE_CHART,
SIGNED_INCOME_STATEMENT,
OTHER
Example:

"ID_CARD"

​
country
string
required

Document country using ISO 3166-1 alpha-3 code.

Example:

"BRA"

​
side
enum<string>

Document side. Required only for ID_CARD, PASSPORT, and DRIVERS_LICENSE.

Available options:
FRONT_SIDE,
BACK_SIDE
Example:

"FRONT_SIDE"

​
associatedPartyId
string<uuid>

Associated party's unique identifier. Required when uploading documents for associated parties.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

201

Document successfully uploaded.