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-ef1234567890import 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_bodyUpload a document
This endpoint uploads a document for a customer’s verification.
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-ef1234567890import 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_bodyAuthorizations
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.
Path Parameters
Customer's unique identifier.
Body
Document file to be uploaded. Maximum size is 50MB. Accepts images (JPG, PNG) and PDF.
Document type.
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, OTHER "ID_CARD"
Document country using ISO 3166-1 alpha-3 code.
"BRA"
Document side. Required only for ID_CARD, PASSPORT, and DRIVERS_LICENSE.
FRONT_SIDE, BACK_SIDE "FRONT_SIDE"
Associated party's unique identifier. Required when uploading documents for associated parties.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Response
Document successfully uploaded.