Skip to main content
POST
Register a document and get a presigned upload URL

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Headers

Idempotency-Key
string

Unique key making the request safely retryable.

Maximum string length: 255

Body

application/json
filename
string
required
Example:

"125-main-st-rent-roll.xlsx"

declared_type
enum<string>
required

Declared/resolved document type; determines the rate-card price and the output schema family.

Available options:
offering_memorandum,
rent_roll,
t12,
other_standard,
other_complex
byte_size
integer
required

Exact size of the file in bytes (max 100 MB).

Required range: x <= 104857600
content_type
string
Example:

"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"

metadata
object

Free-form partner tags, echoed back on the document and in webhook events.

Response

Document created; upload URL issued.

id
string
required
Example:

"doc_01J9ZJXV"

object
string
required
Allowed value: "document"
filename
string
required
declared_type
enum<string>
required

Declared/resolved document type; determines the rate-card price and the output schema family.

Available options:
offering_memorandum,
rent_roll,
t12,
other_standard,
other_complex
status
enum<string>
required
Available options:
pending_upload,
uploaded,
deleted
created_at
string<date-time>
required
upload
object
required
resolved_type
enum<string> | null

Type verified during acceptance; set once the document is submitted to a job.

Available options:
offering_memorandum,
rent_roll,
t12,
other_standard,
other_complex
byte_size
integer
metadata
object