curl --request POST \
--url https://api.example.com/api/v1/customer/storage/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"context": "BENEFIT_DOCUMENT",
"fileName": "avatar.png",
"contentType": "image/png"
}
'import requests
url = "https://api.example.com/api/v1/customer/storage/uploads"
payload = {
"context": "BENEFIT_DOCUMENT",
"fileName": "avatar.png",
"contentType": "image/png"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({context: 'BENEFIT_DOCUMENT', fileName: 'avatar.png', contentType: 'image/png'})
};
fetch('https://api.example.com/api/v1/customer/storage/uploads', 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.example.com/api/v1/customer/storage/uploads",
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([
'context' => 'BENEFIT_DOCUMENT',
'fileName' => 'avatar.png',
'contentType' => 'image/png'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.example.com/api/v1/customer/storage/uploads"
payload := strings.NewReader("{\n \"context\": \"BENEFIT_DOCUMENT\",\n \"fileName\": \"avatar.png\",\n \"contentType\": \"image/png\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/api/v1/customer/storage/uploads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"context\": \"BENEFIT_DOCUMENT\",\n \"fileName\": \"avatar.png\",\n \"contentType\": \"image/png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/storage/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"context\": \"BENEFIT_DOCUMENT\",\n \"fileName\": \"avatar.png\",\n \"contentType\": \"image/png\"\n}"
response = http.request(request)
puts response.read_body{
"key": "temp/users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/user-avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"cdnUrl": "https://static.oabus.com.br/user/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"upload": {
"url": "https://oabus-static-dev.s3.us-east-1.amazonaws.com/",
"fields": {}
},
"expiresIn": 900
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}Sign Upload
Returns presigned POST payload + final CDN URL.
curl --request POST \
--url https://api.example.com/api/v1/customer/storage/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"context": "BENEFIT_DOCUMENT",
"fileName": "avatar.png",
"contentType": "image/png"
}
'import requests
url = "https://api.example.com/api/v1/customer/storage/uploads"
payload = {
"context": "BENEFIT_DOCUMENT",
"fileName": "avatar.png",
"contentType": "image/png"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({context: 'BENEFIT_DOCUMENT', fileName: 'avatar.png', contentType: 'image/png'})
};
fetch('https://api.example.com/api/v1/customer/storage/uploads', 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.example.com/api/v1/customer/storage/uploads",
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([
'context' => 'BENEFIT_DOCUMENT',
'fileName' => 'avatar.png',
'contentType' => 'image/png'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.example.com/api/v1/customer/storage/uploads"
payload := strings.NewReader("{\n \"context\": \"BENEFIT_DOCUMENT\",\n \"fileName\": \"avatar.png\",\n \"contentType\": \"image/png\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/api/v1/customer/storage/uploads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"context\": \"BENEFIT_DOCUMENT\",\n \"fileName\": \"avatar.png\",\n \"contentType\": \"image/png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/storage/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"context\": \"BENEFIT_DOCUMENT\",\n \"fileName\": \"avatar.png\",\n \"contentType\": \"image/png\"\n}"
response = http.request(request)
puts response.read_body{
"key": "temp/users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/user-avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"cdnUrl": "https://static.oabus.com.br/user/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"upload": {
"url": "https://oabus-static-dev.s3.us-east-1.amazonaws.com/",
"fields": {}
},
"expiresIn": 900
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Body
Sign upload payload
Upload context
BENEFIT_DOCUMENT, USER_AVATAR "BENEFIT_DOCUMENT"
Original file name
"avatar.png"
Allowed MIME type
application/pdf, image/png, image/jpeg, image/webp "image/png"
Response
OK
Sign upload result
Object key
"temp/users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/user-avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png"
Public CDN URL
"https://static.oabus.com.br/user/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png"
Presigned POST upload payload
Show child attributes
Show child attributes
Presign TTL in seconds
900