Skip to main content
GET
Retrieve an underwriting-inputs job (poll for status)

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Path Parameters

underwriting_inputs_id
string
required

Query Parameters

wait
integer
default:0

Seconds to hold the request open waiting for the job to reach a terminal state (long polling). 0 (the default) returns the current state immediately.

The response returns as soon as the job completes or fails, so a short job costs one request instead of a sleep loop. If the budget runs out first the request still returns 200 with the job's current state — a still-running job is not an error. Check status and call again.

Capped at 45 seconds, below the 60-second request timeout.

Required range: 0 <= x <= 45

Response

Current job state.

id
string
required
Example:

"uwi_01J9ZK4P"

object
string
required
Allowed value: "underwriting_inputs"
status
enum<string>
required
Available options:
processing,
completed,
failed
sandbox
boolean
required
created_at
string<date-time>
required
progress
object

Present while the job is active.

document_ids
string[]
asset_class
enum<string>
Available options:
multifamily,
self-storage,
industrial-outdoor-storage,
commercial,
industrial,
office,
retail,
hotel
investment_strategy
string
schema_version
string
Allowed value: "underwriting_inputs.v1"
billed
object
billed_total_usd
string
completed_at
string<date-time>
elapsed_seconds
integer

Whole seconds since created_at. Present while the job is active.

poll_after_seconds
integer

Recommended seconds to wait before polling again. Mirrors the Retry-After header.

result_url
string

Present when completed.

error
object