Skip to main content
POST
Upload Client Document
Upload files using multipart/form-data encoding. The maximum file size is 50 MB.

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Client ID

Body

application/json

Document upload via base64-encoded file content.

file
string
required

Base64-encoded file content (supported types: JPEG, PNG, GIF, BMP, WebP, PDF).

name
string

Display name for the document. Defaults to auto-generated name based on file type.

Response

Created

id
integer

Unique document identifier.

name
string

Document display name.

file_name
string

Original uploaded file name.

date_added
string

Datetime when the document was uploaded.

type
string

Document MIME type or file extension.

location
string

URL to the stored document file.

deleted
integer

Soft-delete flag (0 = active, 1 = deleted).

date_deleted
string<date-time> | null

Timestamp when the document was soft-deleted, or null if active.