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

Document Type

Resource representing the available types of documents that can be uploaded

The Document Type resource represents a type of document that can be uploaded to the platform and linked to a job. They're heavily employed by the Info Gathering Checklist.

The API supports querying the list of supported Document Types.

Endpoints

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

Document Type Properties

id

The Document Type's ID

Name

The Document Type's name

Copied
1{
2  "id": "ID",
3  "name": "Identification"
4}

Next steps

Listing Document Types

Last updated on October 11, 2023

Privacy Policy Terms & Conditions© 2024 Taxfyle