Skip to main content
POST
Start an automated underwriting run

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
property
object
required
notification_email
string<email>
required

Receives the signed report link on completion.

document_ids
string[]

Optional supporting documents (billed per rate card on acceptance).

options
object

Response

Run queued.

id
string
required
Example:

"uw_01J9ZK3M"

object
string
required
Allowed value: "underwriting"
status
enum<string>
required
Available options:
queued,
ingesting,
underwriting,
calculating,
completed,
failed
sandbox
boolean
required
created_at
string<date-time>
required
progress
object
property
object

Echo of the submitted property.

document_ids
string[]
billed_total_usd
string
completed_at
string<date-time>
report
object

Present when completed.

summary
object

DRAFT — machine-readable headline results (key underwriting metrics).

error
object