Download Document
Download document belonging to a job in your workspace.
The download document endpoint allows you to retrieve the document's file content.
Endpoint
Method | Url |
---|---|
GET | /v1.0/documents/{document_id}/download |
Note
- The response from this endpoint is a
302 Redirect
to the file contents. - Redirect response is only valid for 30 seconds.
Url Parameters
document_id
•
string
The document's id.
Sample Request
Copied1curl -X GET 'https://api.worklayer.com/v1.0/documents/499d692d-67aa-4127-a45c-b9e27f54afad/download' \2-H 'Authorization: Bearer {token}' \3-L \4-o document.txt
Response
A redirect response to where the file content is located.
Errors
Forbidden
: API Client does not have permission to view documents.Unauthorized
: API Client does not have valid credentials.BadRequest
: Either required properties are missing, or there was a malformed request.Conflict
: The document is in an invalid state.
Last updated on October 21, 2022
Privacy PolicyTerms & Conditions© 2024 Taxfyle