Sign in

v1

latestOpenAPI 3.0.3OGL-UK-3.0raw.githubusercontent.com2025-09-3012629.2 KB
Status
Upload

Get upload status

Check the status of a file upload.

Possible statuses:

  • awaiting_callback - Waiting for virus scan results
  • callback_received - Virus scan complete
  • completed - File transferred to Azure
  • transfer_failed - Azure transfer failed
  • quarantined - File failed virus scan
  • buffer_missing - File buffer not found
get/upload/status/{uploadId}

Path parameters

uploadIdstring uuid required

Upload identifier (UUID)

Response

Upload status retrieved successfully

successboolean required
uploadIdstring uuid required
status'awaiting_callback' | 'callback_received' | 'completed' | 'transfer_failed' | 'quarantined' | 'buffer_missing'

Current status of the upload

originalFilenamestring

Original user filename

filenamestring

System filename with timestamp

originalSpreadsheetNamestring

Timestamped spreadsheet filename

timestampstring date-time
virusScanStatus'clean' | 'infected' | 'pending'

Virus scan result

azureTransferredboolean

Whether file was transferred to Azure

azureBlobNamestring

Blob name in Azure Storage

azureUrlstring uri

URL to file in Azure Blob Storage

azureJsonBlobNamestring

JSON blob name (for form submissions)

azureJsonUrlstring uri

URL to JSON file in Azure Storage

transferErrorstring

Error message if transfer failed

processedAtstring date-time

When processing completed

Example response

{
  "success": true,
  "uploadId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "originalFilename": "data.xlsx",
  "filename": "data_2025-09-30T12-00-00-000Z.xlsx",
  "originalSpreadsheetName": "data_2025-09-30T12-00-00-000Z.xlsx",
  "timestamp": "2025-09-30T12:00:00.000Z",
  "virusScanStatus": "clean",
  "azureTransferred": true,
  "azureBlobName": "data_2025-09-30T12-00-00-000Z.xlsx",
  "azureUrl": "https://storage.blob.core.windows.net/uploads/data_2025-09-30T12-00-00-000Z.xlsx",
  "azureJsonBlobName": "data_2025-09-30T12-00-00-000Z.json"
}