BlucaScan Documentation

API Response Examples

Understand the different response formats you'll receive from BlucaScan based on file scan results and transfer status.

Clean File - Successfully Transferred

Response when a file passes all security checks and is successfully transferred

CLEAN

SUCCEEDED

{
  "fileIdentifier": "fec850b7-7cbb-4ff2-8ff9-23e6489f46c2",
  "fileTransferStatus": "SUCCEEDED",
  "comment": "The file scan and transfer is ongoing as a background process, once it is complete, you will be notified",
  "fileScanResult": {
    "status": "CLEAN",
    "fileName": "example.txt",
    "fileSize": 12345,
    "timeTakenInMillis": 40
  }
}

Background Processing

Response when file scanning and transfer is happening in the background

ASYNC_ONGOING

PROCESSING

{
  "fileIdentifier": "fec850b7-7cbb-4ff2-8ff9-23e6489f46c2",
  "fileTransferStatus": "ASYNC_ONGOING",
  "comment": "The file scan and transfer is ongoing as a background process, once it is complete, you will be notified"
}

You'll receive a webhook notification when background processing is complete.

Malicious File Detected

Response when malware or viruses are detected in the uploaded file

MALICIOUS

SKIPPED

{
  "fileTransferStatus": "SKIPPED",
  "comment": "Transfer NOT attempted, intentionally.",
  "fileScanResult": {
    "status": "MALICIOUS",
    "fileName": "example-malicious.txt",
    "fileSize": 42345,
    "foundViruses": {
      "stream": [
        "Eicar-Signature"
      ]
    },
    "timeTakenInMillis": 40
  }
}

Security Alert: Malicious files are never transferred to prevent contamination of your systems. The file is quarantined and details are logged.

Clean File - Transfer Skipped

Response when a file is clean but transfer is intentionally skipped

CLEAN

SKIPPED

{
  "fileTransferStatus": "SKIPPED",
  "comment": "Transfer NOT attempted, intentionally.",
  "fileScanResult": {
    "status": "CLEAN",
    "fileName": "example.txt",
    "fileSize": 12345,
    "timeTakenInMillis": 40
  }
}

Response Field Definitions

Understanding the key fields in BlucaScan responses

fileIdentifier

Unique UUID for tracking the file through the system

fileTransferStatus

Status of file transfer: SUCCEEDED, SKIPPED, or ASYNC_ONGOING

fileScanResult.status

Scan result: CLEAN or MALICIOUS

foundViruses

Array of detected virus signatures (only present for malicious files)

timeTakenInMillis

Processing time in milliseconds

comment

Human-readable description of the processing status