Skip to content

API Documentation

ConceptsThe Worklayer platformAuthenticationRate LimitsError handling

MemberThe Member ResourceCreate a memberRetrieve a memberRetrieve a member by external IDRetrieve a list of membersUpdate a memberAccept terms for a member

JobsThe Job ResourceRetrieve a job by short IDThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProAssign a supporting clientRemove a supporting clientSubmit a jobRetrieve a list of your jobsList job documentsDelete a jobRetrieve a job checklistComplete info gathering for a jobRequest cancellationRequest reopen

Relationship ManagerRelationship Manager ResourceRetrieve a job relationship manager

Job ProgressionsApprove a draftReject a draftMark job as ready to file

ConsultationsThe Consultation ResourceGet a consultationList consultations

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

Job NotesThe Job Note ResourceCreate a job noteGet a job noteList job notes

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 documentDelete a document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messagesGet unread count

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob DetailsWaitlist

PortalPortal embeddingPortal translations

GuidesFilteringPostman Collection

Listing Document Types

List document types supported by the platform

The "list document types" endpoint allows you to retrieve a paginated list of the various Document Types supported by the platform.

Endpoint

Method	Url
`GET`	`/v1.0/document-types`

Request Parameters

page_size

•

number

The page size for search result pagination. If not provided, the service will default to 50 items.

page_token

•

string

The page to fetch, if any. This is the next_page_token value returned from the previous request.

Sample Request

bashCopied
1curl -X GET 'https://api.worklayer.com/v1.0/document-types' \
2-H 'Authorization: Bearer {token}'

Response

data

•

list

The document types supported by the platform. See the Document Type reference page for more information. The order of these document types should not be depended upon.

next_page_token

•

string

The pagination token to retrieve the next page of results. If the value is "" or null, no further results exist.

Sample Response

jsonCopied
1{
2  "data": [
3    {
4      "id": "K1",
5      "name": "K-1",
6    },
7    {
8      "id": "1099_B",
9      "name": "1099-B, 1099-COMPOSITE",
10    },
11    {
12      "id": "FOREIGN_BANK_STMT",
13      "name": "Last month bank statement",
14    }
15  ],
16  "next_page_token": "ZGF0ZS9kYXRlX2NyZWF0ZWQvZGVzYy8xNjk0MTAwNzQ5MzY5"
17}

Errors

Forbidden: API Client cannot list documents types.
Unauthorized: API Client does not have valid credentials.
BadRequest: There was a malformed request.

Last updated on October 11, 2023

Privacy Policy Terms & Conditions© 2026 Taxfyle