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 documentsDelete a jobRetrieve a job checklistComplete info gathering for a jobRequest cancellationRequest reopen

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeList consultation service itemsCreate job scope change requestApprove a job scope changeReject a job scope change

Job TemplatesThe Job Template ResourceRetrieve available job templates

Personal ProfilesThe Personal Profile ResourceRetrieve a personal profileSave a personal profileProvide a personal profile to a jobRetrieve a personal profile for a job

Spousal ProfilesThe Spousal Profile ResourceRetrieve a spousal profileSave a spousal profileProvide a spousal profile to a jobRetrieve a spousal profile for a job

Dependent ProfilesThe Dependent Profile ResourceList dependent profilesRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileDelist a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceList business profilesCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobDelist a business profileProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceList tax refund methodsCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodDelist a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messages

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

Request Cancellation

Request job cancellation.

Request cancellation for a job. If the cancellation request is approved, the job's status will change to CANCELLED.

This endpoint allows you to submit a cancellation request with a reason. The request will be reviewed and processed accordingly.

Endpoint

Method	Url
`POST`	`v1.0/jobs/{job_id}/request-cancellation`

Url Parameters

job_id

•

guid

ID of the job to request cancellation for.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs/499d692d-67aa-4127-a45c-b9e27f54afad/request-cancellation' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{
5  "requested_by_user_id": "7c4e2b1a-9d3f-4e5a-8b6c-3f7d8e9a1b2c",
6  "reason": "Client no longer needs tax preparation services"
7}'

Request Payload

requested_by_user_id

•

guid

required

ID of the user requesting cancellation.

reason

•

string

required

A clear explanation for why the job needs to be cancelled.

Response

An empty response indicates that the cancellation request was successfully submitted.

Sample Response

Copied
1{}

Last updated on August 8, 2025

Privacy Policy Terms & Conditions© 2025 Taxfyle