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 scopeList consultation service itemsCreate job scope change requestApprove 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

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 ResourceRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate 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

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

Create Tax Refund Method

Create a new tax refund method.

This endpoint creates a new tax refund method for a user. Any subsequent updates to this method should use the update endpoint.

Each creation results in a new tax refund method with version 1.

Endpoint

Method	Url
`POST`	`/v1.0/users/:user_id/tax-refund-methods`

Path Parameters

user_id

•

string

required

ID of the user to create the tax refund method for.

Request Body

refund_type

•

string

required

Type of tax refund. Must be one of:

PERSONAL - For individual tax returns
BUSINESS - For business tax returns

delivery_method

•

object

required

Specification for how the refund should be delivered. See Tax Refund Method Resource.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/users/a385a314-12f9-4ee3-a838-c8785d5db610/tax-refund-methods' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{
5  "refund_type": "PERSONAL",
6  "delivery_method": {
7    "direct_deposit": {
8      "bank_account": {
9        "account_type": "CHECKING",
10        "routing_number": "123456789",
11        "account_number": "987654321"
12      }
13    }
14  }
15}'

Response

id

•

string

Unique identifier of the created tax refund method.

version

•

integer

Version number of the created tax refund method.

Sample Response

Copied
1{
2  "id": "550e8400-e29b-41d4-a716-446655440000",
3  "version": 1
4}

Errors

400: Future tax credit as a delivery method is only allowed for business refund types
403: Not authorized to create a refund method

Next steps

Update a tax refund method

Last updated on November 1, 2024

Privacy Policy Terms & Conditions© 2025 Taxfyle