This API is simple to use. You just have to follow these steps

• Create a free account
• Click on the link you receive by email to confirm your address
• Generate a token with credentials

You can use any language to make this CURL call. (Python, PHP, Java, JavaScript...) Need help ?

curl --location --request POST 'https://mxprocess.com/api/login_check' \ --header 'Content-Type: application/json' \ --data-raw '{"username":"YOUR_LOGIN","password":"YOUR_PASSWORD"}'

If your credentials are correct, our server will provide you with a token as a response : {"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}
YOUR_TOKEN is valid for one hour, its duration can be extended using YOUR_REFRESH_TOKEN


• Use the token to start the process asynchronously
Downloading results: when it is present in an API response, actionResultsDownloadURLs contains the authenticated URLs for downloading each generated result file.



Asynchronous API: universal file inspection

Submit one non-empty file up to 50 MiB. The original is read but never moved, changed or deleted. The report is diagnostic: the antivirus engine result is a preliminary triage signal, and the included detection rule set is only a minimal starting set.

Endpoint: POST https://mxprocess.com/api/files/start-process
Authentication: Bearer JWT
Cost: 12 tokens, charged after success.

Start an inspection

curl --location --request POST 'https://mxprocess.com/api/files/start-process' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --form 'actionName=FileInspection' \ --form 'file=@/path/to/file.bin' \ --form 'parameters=[]' \ --form 'async=true'

Save the returned id and poll /api/actions/get-action-infos/{id} with the same JWT. When complete, actionResults contains one authenticated downloadable *.inspection.json file.

Initial response

{"id":123,"action":{"actionName":"FileInspection","slug":"inspect-file-online"},"accomplished":false,"actionResults":[],"trackingUrl":"https://mxprocess.com/api/actions/get-action-infos/123"}

Completed report

{ "fileName": "photo.jpg", "sizeBytes": 24576, "sha256": "...", "mimeDetected": "image/jpeg", "mimeDeclared": null, "antivirusSignal": {"status": "clean", "detail": "preliminary triage signal"}, "exif": {"ImageWidth": 800, "ImageHeight": 600}, "mediaProbe": null, "detectionRules": {"status": "clean", "matches": [], "ruleset": "minimal detection rule set"}, "ocrText": "Complete text detected in the image...", "generatedAt": "2026-09-12T12:00:00+00:00" }

If an optional local tool is unavailable, its section is returned as not_run or null. An invalid cardinality, inaccessible file or file over 50 MiB is rejected before analysis.

Contact us


The API sends you a Json response to confirm that the process has started. take note of the "trackingUrl" field, it is the one that allows you to follow the process that you have launched. In this answer you also find the ID of your process, here in our example the ID is 643 : { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "FileInspection", "slug": "inspect-file-online", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": false, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "trackingUrl": "https://mxprocess.com/api/actions/get-action-infos/643" }


• So to follow the progress, you do a simple GET(you can make this http call every 10 seconds):
curl --location 'https://mxprocess.com/api/actions/get-action-infos/643' \ --header 'Authorization: Bearer YOUR_TOKEN' }}

If the process is not yet completed, you will receive this type of response with "accomplished": false { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": null, "endTime": null, "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "FileInspection", "slug": "inspect-file-online", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": false, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "executionPlannedAt": null, "trackingUrl": "" }

If the process is completed, you will receive this type of response with "accomplished": true. The actionResultsDownloadURLs field contains the authenticated URLs for downloading the generated results: { "actionResultsDownloadURLs": [ "https://mxprocess.com/api/actions/download-result/643/35084b44a841ec597be3048df44145e8.txt.log/YOUR_TOKEN" ], "id": 643, "actionParameters": { "commandParameters": "" }, "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": "2024-01-28T11:24:49+01:00", "endTime": "2024-01-28T11:25:09+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "FileInspection", "slug": "inspect-file-online", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": true, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [ [ "35084b44a841ec597be3048df44145e8.txt.log" ] ], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "executionPlannedAt": null, "trackingUrl": "" }

Use each URL supplied in actionResultsDownloadURLs directly to download its corresponding result.

This documentation is not clear? (Python, PHP, Java, JavaScript...) Need help ?

Contact us This API is also available in synchronous mode : Developer API : FileInspection