POST
/
documents
Upload a verification document
curl --request POST \
  --url https://api.balansas.com/functions/v1/customer-api/documents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "endUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fileName": "<string>",
  "fileData": "<string>"
}
'
import requests

url = "https://api.balansas.com/functions/v1/customer-api/documents"

payload = {
"endUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileName": "<string>",
"fileData": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fileName: '<string>',
fileData: '<string>'
})
};

fetch('https://api.balansas.com/functions/v1/customer-api/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.balansas.com/functions/v1/customer-api/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 => json_encode([
'endUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fileName' => '<string>',
'fileData' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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.balansas.com/functions/v1/customer-api/documents"

payload := strings.NewReader("{\n \"endUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileName\": \"<string>\",\n \"fileData\": \"<string>\"\n}")

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

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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.balansas.com/functions/v1/customer-api/documents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"endUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileName\": \"<string>\",\n \"fileData\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.balansas.com/functions/v1/customer-api/documents")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileName\": \"<string>\",\n \"fileData\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "storage_path": "a1b2c3.../e5f6.../1716901234567_passport.pdf",
    "fr_document_id": "doc_7h8i9j0k1l2m",
    "status": "uploaded",
    "fr_sync_status": "pending",
    "message": "Document uploaded to storage. Provider sync will be retried."
  }
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}

Authorizations

x-api-key
string
header
required

Customer API key. Send as x-api-key: sk_... or Authorization: Bearer sk_.... Write operations also require an X-CSRF-Token header (64-char hex).

Body

application/json
endUserId
string<uuid>
required
documentType
enum<string>
required
Available options:
IDENTITY_VERIFICATION,
BUSINESS_REGISTRATION,
identity,
proof_of_address,
other
fileName
string
required
Required string length: 1 - 255
fileData
string
required
mimeType
enum<string>
required
Available options:
application/pdf,
image/jpeg,
image/png

Response

Success

data
object
required