Skip to main content
POST
Upload Json

Authorizations

capout-api-key
string
header
required

Organization-scoped CapOut API key

Headers

Idempotency-Key
string | null

Body

application/json

Version 1 typed contract for structured estimate imports.

file_name
string
required

Source filename

Minimum string length: 1
line_items
StructuredLineItemV1 · object[]
required

Nonempty ordered list of line items

Minimum array length: 1
schema_version
string
default:1

Contract schema version, must be '1'

Allowed value: "1"
estimate_name
string | null

Display project or estimate name

claim_number
string | null

Insurance claim number

policy_number
string | null

Insurance policy number

insured_name
string | null

Insured client name

property_address
string | null

Property address

date_of_loss
string | null

Date of loss (ISO format)

carrier_name
string | null

Insurance carrier name

price_list
string | null

Target Xactimate price list binding code

Response

Successful Response

Response body for POST /upload.

document_id
string
required

Public document ID for status polling, realtime subscriptions, and ESX downloads.

created_at
string<date-time>
required
status_url
string
required
download_url
string
required

Stable authenticated ESX download URL. It redirects to the Contractor profile by default once export is complete.

contractor_download_url
string
required

Stable authenticated URL for the Contractor (8D) ESX file

carrier_download_url
string
required

Stable authenticated URL for the Carrier (5L) ESX file

status
string
default:processing
ws_url
string
default:/ws/status
source_type
string
default:PDF