File API Endpoint

This API endpoint allows downloading any processed or extracted (e.g. image embedded in a document) binary file. In order to retrieve a file, the SHA256 digest needs to be known. The reporting data as returned by /task will contain a variety of digests. The retrieved binary data is contained within the JSON response as a Base64 string. The decoded string is an inflated gzipped version.

Note: the "mediaType" returned is the media type of the underlying file.

Syntax

GET https://<ip>:<port>/file

Parameters

Name	Type	Required?	Description
secret	String	Y	Authentication secret
sha256	String	Y	SHA256 digest as found in the response of /submit or extracted resource in the reporting

Example Response

{ "processTime": 29, "fileSize": 298083, "mediaType": { "string": "text/plain", "slash": 4, "semicolon": 10, "parameters": {} }, "digests": { "SHA-1": "89f1e80601aad4a29f6b0d9dac27dbbc8043911e", "SHA-256": "ded996a1b8ecb407d0e33d2177d50ade036cbe8d1680dda4329bbd878f433ac1", "SHA-512": "2f28c0e765d031bbf166223ab5b732a7c8308c6421233ae776414938066e2b082ae1f-0799b56e0feb7e5da430e315b1ff0b1a60f6b47d36c22548c56a2d2c00d", "MD5": "e82aded7b074aaa0110445219bdbc6a1" }, "compressedBase64": "KjFkN0hQY1ljUE5O(..)" }

Last updated on

Was this page helpful?