POST
/
api
/
v2.1
/
document
/
upload
Upload a new document
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/document/upload \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --data '{
  "customerId": "<string>",
  "organizationId": "<string>",
  "fileName": "<string>",
  "fileType": "<string>",
  "purpose": "<string>",
  "contentType": "<string>",
  "content": "<string>",
  "expiryDate": "2022-03-10T00:00:00.000Z",
  "description": "<string>",
  "category": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": "<any>"
}

Headers

X-Forwarded-For
string
required

Forwarded client IP address

User-Agent
string

Client user agent information

X-Tenant-ID
string

Tenant identifier for multi-tenant operations

Body

application/json
fileName
string
required
fileType
string
required
purpose
string
required
contentType
string
required
content
string
required
customerId
string
organizationId
string
expiryDate
string<date>
Example:

"2022-03-10T00:00:00.000Z"

description
string
category
string

Response

Document uploaded successfully

success
boolean
message
string
data
any