post
/{tenantId}/v1/documents/{documentId}/confirmConfirm document upload
Requires Authentication
Documents
Confirms that the file has been uploaded to S3. The service verifies the object
exists via a HEAD request and updates the document status from "pending" to "ready".
Path Parameters
| Name | Type | Description |
|---|---|---|
tenantIdrequired | string (uuid) | Tenant UUID |
documentIdrequired | string (uuid) | Document UUID |
Responses
Document confirmed and status updated to ready
Response Bodyapplication/json
idstring (uuid)
tenantIdstring (uuid)
documentSetIdstring (uuid)
- ID of the document set this document belongs to, null if standalonefileNamestring
- Original file namecontentTypestring
- MIME content type (e.g., application/pdf, image/png)fileSizeinteger (int64)
- Expected file size in bytesstatusstring
enum: "pending" | "ready" | "failed"- Document status (pending = awaiting upload, ready = uploaded and confirmed)createdAtstring (date-time)
updatedAtstring (date-time)
Code Examples
curl -X POST 'https://api-next.checkio.co.uk/{tenantId}/v1/documents/{documentId}/confirm' \
-H 'Authorization: Bearer {token}'