Batch Upload API
GET Download
Overview
This endpoint allows the download of files related to a specific Job ID. When you make a GET request to this path, the server responds with a ZIP file or a message indicating that no files related to the given Job ID were found.
OperationId: GET Download
Authorization Method(s): OAuth
Verb: GET
End Point: /api/v1/Download
Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.
| Display String | Field Name | Field Type |
|---|---|---|
| X-request-id* | x-request-id | string |
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The api responds a zip file ready to download. |
| 204 | No Content - No files found related to job id |
| 400 | Bad Request - Validation exception like GUID invalid |
| 401 | Unauthorized - Please provide a valid access token or authenticate with proper credentials |
| 404 | The requested resource could not be found. Please check the URL or request parameters. |