Skip to content

API Documentation

ConceptsThe Worklayer platformAuthentication

MemberThe Member ResourceCreate a memberRetrieve a list of membersUpdate a member

JobsThe Job ResourceThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProSubmit a jobRetrieve a list of your jobsList job documentsRetrieve a job url - DEPRECATEDDelete a jobRetrieve a job checklistComplete info gathering for a job

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeApprove a job scope changeReject a job scope change

Job TemplatesThe Job Template ResourceRetrieve available job templates

Service PackagesThe Service Package ResourceRetrieve a list of your service packagesSubmit service package answers

DocumentsThe Document ResourceCreate a documentGet a documentDownload a document

Document TypesThe Document Type ResourceList document types

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

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

Copied
1curl -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 Policy Terms & Conditions© 2024 Taxfyle