ScanThis API

We provide a simple HTTP POST & JSON string based API for you to use. In fact we use it ourselves to provide the AJAX (AJAJ?) features of this site!

The API works by accepting an action string and extra values. We accept the following actions:

Upload

This action allows you to upload a file to our server for scanning. The return value will either be a message of success containing a unique ID string you can use to retrieve the scan results, or an error string describing what went wrong.

POST Data

Successful Return

Error Return

Download

This action allows you to provide a URL for us to download to our servers for scanning. The return value will either be a message of success containing a unique ID string you can use to retrieve the scan results, or an error string describing what went wrong.

POST Data

Successful Return

Error Return

Check

This action allows you to check the status of a scan. You may need to poll this action a few times until you get the scan results back. We ask that you wait approximately 15 seconds after posting before your first poll, it would be reasonable to poll on 5 seconds after that.

POST Data

Successful Return

Error Return