Skip to main content
POST
/
v1
/
files
Generate presigned upload URL
curl --request POST \
  --url https://api.sandbox.busha.so/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "generic",
  "file_type": "application/pdf",
  "file_name": "document.pdf",
  "document_id": "123",
  "key_only": false
}
'
{
  "status": "success",
  "message": "message for success",
  "data": {
    "upload_url": "https://s3.amazonaws.com/bucket/key?signature=...",
    "public_link": "https://cdn.busha.co/generic/123/document.pdf",
    "expires_at": "2024-01-01T00:00:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer Authentication

Headers

​
X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Body

application/json

Request parameters for presigned URL

​
category
enum<string>
default:generic
required
Available options:
generic,
avatar,
document,
usd_payment_proof,
checkout-logo,
business-logo,
compliance-docs,
index
​
file_type
string
Example:

"application/pdf"

​
file_name
string
Example:

"document.pdf"

​
document_id
string
Example:

"123"

​
key_only
boolean
default:false

Response

Successful response

General response Values

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
message
string
required
Example:

"message for success"

​
data
object
required