Skip to main content
POST
Upload a file

Authorizations

Authorization
string
header
required

Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.

Body

multipart/form-data
file
file
required
purpose
enum<string>
required
Available options:
identity_document,
formation_document,
additional_document,
tax_form_1099,
business_logo,
business_icon

Response

The uploaded file.

A file: either a document Clemta published on one of your companies (source: operations - Articles, an EIN letter, a filed form - download the bytes from the content endpoint) or one you uploaded (source: upload - write-only, attach it by id). Nothing about storage is ever exposed - no URLs, no keys. Uploaded contents cannot be read back.

object
enum<string>
required

Entity name.

Available options:
file
id
string
required
Pattern: ^file_[0-9A-Za-z]{22}$
Example:

"file_0346sFPEvSkJvY8vt14NNw"

name
string
required

The document's filename, extension included.

Example:

"Articles_of_Incorporation.pdf"

livemode
boolean
required
created_at
string<date-time>
required
company
string

The company this document belongs to. Absent on an upload not yet attached.

Pattern: ^cmp_[0-9A-Za-z]{22}$
content_type
string
Example:

"application/pdf"

size
integer<int64>

Size in bytes, when known.

purpose
enum<string>

What an uploaded file is for. Absent on documents Clemta published.

Available options:
identity_document,
formation_document,
additional_document,
tax_form_1099,
business_logo,
business_icon
source
enum<string>

Who put the file here. operations - a deliverable we published, its bytes downloadable from the content endpoint. upload - you sent it (POST /v1/files), write-only: reference it by id, its contents can never be read back.

Available options:
operations,
upload
url
string

Where the file's contents can be downloaded, with your API key. Present only when the purpose allows downloading - Clemta-published deliverables, never your own uploads.

consumed
boolean

True once an upload has been attached. Uploads are single-use.