Example outputs

Possible status codes:

Sanitized
Sanitized Partially
Sanitization Timeout
Sanitization Failed
Sanitization Skipped

Example successful sample output

In sanitized object you can find these values (they differ with file type and existing potentially malicious objects):

action: "removed" | "sanitized" | "skipped"
name: str
count: int | null
data: List[str] | str | null
sha256: List[str] | str | null

{
    "status": "Sanitized",
    "sanitized_file_info": {
        "description": "Sanitized successfully",
        "file_type": "WORD 97-2003",
        "file_size": 95232,
        "sha256": "e5b466f6aea99d4e0ac017bfe2fe5298371bd792868d87a62897ff2072438d07",
        "name": "file-sample_100kB.2_sanitized.doc",
        "details": [
            {
                "action": "removed",
                "name": "Metadata"
            },
            {
                "action": "removed",
                "name": "OLE Object",
                "count": 3
            },
            {
                "action": "removed",
                "name": "Hyperlink",
                "count": 1,
                "data": [
                    "https://products.office.com/en-us/word"
                ],
                "sha256": [
                    "cac497b6d1ed660dc7e4100bb0f85ebbb3d469ba5eda6208585aa30790dd9041"
                ]
            }
        ]
    },
    "files": [
        {
            "name": "file-sample_100kB.2_sanitized.doc",
            "path": "file-sample_100kB.2_sanitized.doc"
        }
    ],
    "elapsed_time": "1.08549 seconds"
}

Example failed sample output

{
    "status": "Sanitization Failed",
    "sanitized_file_info": {
        "error": "Unsupported file type",
        "message": "File type is not supported. MS Office document is older than 97 format",
        "file_type": "WORD95"
    },
    "files": []
}

Possible error codes when Sanitization Failed:

Parser failed
Unsupported file type
Password protected
File is empty
File not found
Out of memory (Occurs with big Office files)
Sanitization failed (Unknown errors during sanitization, contact with support team)