Skip to main content
GET
Retrieve an underwriting run (poll for status)

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Path Parameters

underwriting_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 run state; report link and summary when complete.

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.

end_user_ref
string

Echo of the submitted end-user identifier, when one was supplied.

document_ids
string[]
billed_total_usd
string
completed_at
string<date-time>
elapsed_seconds
integer

Whole seconds since created_at. Present while the run is active, so a caller can tell a run that just started from one approaching the 4-hour ceiling without doing date math.

Example:

640

poll_after_seconds
integer

Recommended seconds to wait before polling again. Present while the run is active; mirrors the Retry-After header. Prefer this over a hard-coded interval.

Example:

30

report
object

Present when completed.

summary
object

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

error
object