Skip to main content
POST
What-if on a finished report

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Headers

X-Cactus-End-User
string

Act for one of your end users (the end_user_ref you pass when creating underwritings). Limits every underwriting, document and extraction call to that user's resources. Required on MCP connections once your account serves end users.

Maximum string length: 255

Path Parameters

underwriting_id
string
required

Body

application/json
changes
object[]
required
Required array length: 1 - 50 elements

Response

The preview.

object
string
required
Allowed value: "underwriting_preview"
underwriting_id
string
required
saved
boolean
required
changes
object[]
required
before
object
required

Headline figures of the saved report.

after
object
required

The same figures with the changes.

derived_changes
object[]

Assumptions the model changed on its own because of the requested ones (e.g. a lease-up valuation switch). assumption_id is null for a model setting that isn't in the assumptions list.

disclosure
string

Why the model made the derived changes.