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

Questionnaire Answers

Submit answers to required questions from questionnaire.

The questionnaire answers endpoint lets you provide answers to required questions specified by the Questionnaire.

Endpoint

Method	Url
`PUT`	`/v1.0/jobs/{job_id}/questionnaire/answers`

Note

This endpoint follows PUT semantics, meaning you should always send the full set of answers for all questions as they'll be overridden every time

Url Parameters

job_id

•

guid

The job's ID.

Request Payload

answers

•

object

An object mapping question IDs to answers as specified in the Questionnaire questions field.

Type	Answer Format
`BOOL`	A boolean; either `true` or `false`
`NUMERIC`	A number; e.g `23`
`TEXT`	A string; e.g. `"Hello world"`
`DATE_TIME`	A string of a timestamp; e.g `"2022-11-04T04:00:00.000Z"`
`SINGLE_SELECT`	An id from the provide `options`; e.g.`"OPTION1"`
`MULTI_SELECT`	An array of ids from the provide `options`; e.g. `[“OPTION1”, "OPTION2"]`

Sample Request

Copied
1curl -X PUT 'https://api.worklayer.com/v1.0/jobs/{job_id}/questionnaire/answers' \
2-H 'Authorization: Bearer {token}'
3-H 'Content-Type: application/json' \
4-H 'Accept: application/json' \
5-d '
6{
7    "answers": {
8        "QUESTION_1": true,
9        "QUESTION_2": 10,
10        "QUESTION_3": "Hello World",
11        "QUESTION_4": "2022-11-04T04:00:00.000Z",
12        "QUESTION_5": "OPTION1",
13        "QUESTION_6": ["OPTION1", "OPTION2"]
14    }
15}'

Response

ready_to_submit

•

boolean

To signal whether or not enough answers have been provided for any question in the questionnaire for the job to be submitted to the pool of Tax Pros.

update_time

When the answers were updated. A timestamp in format 2021-04-28T13:45:25.781Z.

Sample Response

Copied
1{
2    "ready_to_submit": true,
3    "update_time": "2021-04-28T13:52:27.379Z"
4}

Next steps

Submit job

Last updated on October 11, 2023

Privacy Policy Terms & Conditions© 2024 Taxfyle