Upload a document - Lumx

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

import requests

url = "https://api.lumx.io/customers/{id}/documents"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "type": "ID_CARD",
    "country": "BRA",
    "side": "FRONT_SIDE",
    "associatedPartyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('type', 'ID_CARD');
form.append('country', 'BRA');
form.append('side', 'FRONT_SIDE');
form.append('associatedPartyId', 'a1b2c3d4-e5f6-7890-abcd-ef1234567890');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.lumx.io/customers/{id}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumx.io/customers/{id}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumx.io/customers/{id}/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lumx.io/customers/{id}/documents")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/customers/{id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "documentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"
}

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

import requests

url = "https://api.lumx.io/customers/{id}/documents"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "type": "ID_CARD",
    "country": "BRA",
    "side": "FRONT_SIDE",
    "associatedPartyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('type', 'ID_CARD');
form.append('country', 'BRA');
form.append('side', 'FRONT_SIDE');
form.append('associatedPartyId', 'a1b2c3d4-e5f6-7890-abcd-ef1234567890');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.lumx.io/customers/{id}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumx.io/customers/{id}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumx.io/customers/{id}/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lumx.io/customers/{id}/documents")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/customers/{id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nID_CARD\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\nBRA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"side\"\r\n\r\nFRONT_SIDE\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"associatedPartyId\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "documentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"
}

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. Use the LIMIT_REQUEST_* types for the supporting document of a limit-increase request.

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,

PROOF_OF_ADDRESS,

LIMIT_REQUEST_BANK_STATEMENT,

LIMIT_REQUEST_TAX_RETURN,

LIMIT_REQUEST_FINANCIAL_STATEMENTS,

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

200 - application/json

Document successfully uploaded.

documentId

string<uuid>

Uploaded document's unique identifier. Reference it as supportingDocumentId when creating a limit request.

Example:

"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"