BlucaScan Documentation

Scan Results & Status Codes

Understand the different scan results and status codes returned by BlucaScan. Learn how to interpret scan outcomes and handle different scenarios in your application.

Clean Files

Files that pass all security checks

CLEAN

No threats detected

Files marked as CLEAN have passed all security scans and are safe for transfer to your destination server. These files contain no known malware, viruses, or suspicious content.

✓ Safe for processing

✓ Eligible for transfer

✓ No security concerns

Malicious Files

Files containing threats or malware

MALICIOUS

Threats detected

Files marked as MALICIOUS contain known viruses, malware, or other security threats. These files are automatically blocked from transfer and quarantined for security.

⚠ Security threat detected

⚠ Transfer blocked

⚠ File quarantined

Transfer Status Codes

Understanding file transfer status indicators

SUCCEEDED

File was successfully transferred to the destination server. The transfer completed without errors.

ASYNC_ONGOING

File transfer is in progress as a background process. You'll receive a webhook notification when complete.

SKIPPED

Transfer was intentionally not attempted. This occurs for malicious files or when transfer is disabled.

FAILED

Transfer attempt failed due to network issues, server errors, or configuration problems.

Virus Detection Details

Information provided when malicious content is detected

foundViruses Object

When malicious content is detected, the response includes detailed information about the threats found:

{
"data": {
    "fileScanResult": {
      "status": "MALICIOUS",
      "fileName": "suspicious.exe",
      "fileSize": 1024000,
      "foundViruses": {
        "stream": ["Trojan.Generic", "Malware.Detected"]
      },
      "timeTakenInMillis": 85
    },
    "fileTransferStatus": "SKIPPED"
  }
                  }

Common Virus Types

Eicar-Signature

Test signature

Trojan.*

Trojan horses

Malware.*

General malware

Virus.*

Computer viruses

Detection Streams

stream

Primary detection stream for file content analysis

metadata

Metadata-based threat detection (future feature)

Processing Time: The timeTakenInMillis field indicates how long the scan took to complete. Larger files typically require more processing time.

Handling Different Scenarios

Best practices for processing different scan results

Clean File Processing

• Process the file normally in your application
• File is safe for storage and further processing
• No additional security measures required
• Log successful scan for audit purposes

Malicious File Handling

• Reject the file upload immediately
• Log the incident with virus details
• Notify administrators of the security event
• Consider blocking the source if repeated attempts

Background Processing

• Acknowledge receipt to the user
• Set up webhook handling for completion notification
• Provide status tracking using fileIdentifier
• Handle both success and failure scenarios