Skip to main content
POST
Upload Document

Headers

capout-api-key
string | null

Body

application/json

Request body for POST /upload.

file_name
string
required

Original filename

xn_address
string
required

Xactnet recipient address for this upload

profile_code
enum<string>
required

Xactimate profile code. Accepted values are 5L (Carrier) and 8D (Contractor).

Available options:
5L,
8D
Example:

"5L"

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

Response

Successful Response

Response body for POST /upload.

document_id
string
required
created_at
string<date-time>
required
status_url
string
required
workflow_id
string | null
status
string
default:processing
ws_url
string
default:/ws/status