Skip to main content
POST
Upload Document

Authorizations

capout-api-key
string
header
required

Organization-scoped CapOut API key

Body

application/json

Request body for POST /upload.

file_name
string
required

Original filename

file_base64
string | null

Base64-encoded PDF file

url
string | null

Downloadable HTTPS URL to a PDF that the server can fetch immediately

s3_path
string | null

Existing protected S3 path previously created by POST /upload-url

xn_address
string | null

Deprecated optional Xactnet recipient address. Direct ESX generation does not send files through XactNet.

profile_code
enum<string> | null

Deprecated optional Xactimate profile code. Both Carrier (5L) and Contractor (8D) files are generated; choose one on the download URL.

Available options:
5L,
8D
Example:

"5L"

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