Skip to navigation
APIDocuments

Confirm upload

Confirms one uploaded file has landed and starts processing it. Answers 503 when the processing pipeline is not configured and 502 when it fails to start.

Requires the documents:write scope. Rate limit: 1000 requests per minute per key (the upload lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

job_idstringRequired
The upload's job id.

Headers

Idempotency-KeystringOptional<=255 characters

Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Request

This endpoint expects a nullable object.
sample_documentstring or nullOptional<=64 characters

Test-mode only. Selects which seeded sample document the confirm returns. Must be one of the seeded sample-document ids; an unrecognized value is rejected with 400. Ignored on the live path.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
Idempotency-Replayboolean

Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
job_idstring
statusenum
Allowed values:
duplicate_of_job_idstring or nullOptional

The prior job whose extraction this upload duplicates. Present only on a "DUPLICATE" status; omitted otherwise.

messagestring or nullOptional

Human-readable explanation accompanying a non-PROCESSING status. Omitted when there is nothing to explain.

child_jobslist of objects or nullOptional
One row per file found in a ZIP upload. Omitted on any other upload.
sampleboolean or nullOptional

true when this confirm returned test-mode sample data rather than a real extraction. Omitted on live responses.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error