Download a document file
const url = 'http://api.probatix.localhost/v1/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/download?XDEBUG_SESSION=PHPSTORM';const options = { method: 'GET', headers: {'accept-language': 'de', 'X-API-TOKEN': '<X-API-TOKEN>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'http://api.probatix.localhost/v1/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/download?XDEBUG_SESSION=PHPSTORM' \ --header 'X-API-TOKEN: <X-API-TOKEN>' \ --header 'accept-language: de'Returns the document as a binary file download. The response body is raw binary data, not JSON. Content negotiation is not used for this endpoint, and the Accept header is ignored. Use the response Content-Type and Content-Disposition headers to determine the actual file type and filename.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”DocumentDownload identifier
Header Parameters
Section titled “Header Parameters”Language for Errors and Translatable properties
Example
deQuery Parameters
Section titled “Query Parameters”Xdebug session for debugging
Example
?XDEBUG_SESSION=PHPSTORMResponses
Section titled “Responses”Binary document download
Binary file contents of the requested document. Inspect the Content-Type response header for the actual media type, for example application/pdf.
Headers
Section titled “Headers”Unauthorized
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "@context": { "hydra": "http://www.w3.org/ns/hydra/core#" }, "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}Forbidden
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "@context": { "hydra": "http://www.w3.org/ns/hydra/core#" }, "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}Not found
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "@context": { "hydra": "http://www.w3.org/ns/hydra/core#" }, "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}