Uploading Status
Check the processing status of a file upload
Polling Strategy
status is QUEUED or PROCESSING. Stop polling once the status reaches a terminal state (COMPLETED, COMPLETED_WITH_FAILURES, FAILED, or CANCELLED) or a paused state (NEEDS_CLARIFICATION).Status Values
| Status | Terminal? | Description |
|---|---|---|
QUEUED | No | Upload received, waiting for a worker to pick it up |
PROCESSING | No | Worker is actively parsing the file and creating policies/transactions |
COMPLETED | Yes | All rows processed successfully |
COMPLETED_WITH_FAILURES | Yes | Processing finished but some rows failed — check errors array |
NEEDS_CLARIFICATION | No | Processing paused — AI matching requires user input to continue |
FAILED | Yes | Processing failed entirely |
CANCELLED | Yes | Processing was cancelled |
Response Shape
Response Fields
| Field | Type | Description |
|---|---|---|
uploadId | string | The upload request ID |
status | string | Current processing status (see table above) |
totalRows | number | Total number of data rows in the uploaded file |
created | number | Number of new policies created |
updated | number | Number of existing policies updated (duplicate policyNumber re-uploads) |
failed | number | Number of rows that failed processing |
errors | array | Details about individual row failures (see below) |
createdAt | string | ISO 8601 timestamp when the upload was initiated |
updatedAt | string | ISO 8601 timestamp of the last status update |
Error Object
Each entry in theerrors array describes a single row failure:
| Field | Type | Description |
|---|---|---|
index | number | Zero-based index of the failed row |
policyNumber | string? | Policy number from the failed row (if available) |
error | string | Human-readable error message |
Example Responses
In Progress
Completed With Failures
Error Scenarios
Upload Not Found (404)
Returned whenuploadId doesn’t exist or belongs to a different upstream entity.
Unauthorized (401)
Missing or invalid authentication token. See Authentication.Path Parameters
ID of the upload request returned by POST /policies/upload
"6650a1b2c3d4e5f6a7b8c9d0"
Response
Upload processing status with record counts and errors
ID of the upload request
"6650a1b2c3d4e5f6a7b8c9d0"
Current processing status
QUEUED, PROCESSING, COMPLETED, COMPLETED_WITH_FAILURES, NEEDS_CLARIFICATION, CANCELLED, FAILED "COMPLETED"
Total number of data rows in the uploaded file
1000
Number of new policies created
851
Number of existing policies updated (duplicate policyNumber re-uploads)
149
Number of rows that failed processing
0
Details about individual row failures
ISO 8601 timestamp when the upload was initiated
"2025-01-15T10:30:00.000Z"
ISO 8601 timestamp of the last status update
"2025-01-15T10:31:45.000Z"