Uploads a new document for an employee and returns the stored document metadata.

post

https://example.com/wep/companies/{companyId}/employees/{employeeId}/documents

Access: caller types allowed by Worklio.Common.ExtApi.WEP.Attributes.AllowEmployeeAttribute.

This endpoint consumes multipart/form-data. The uploaded file is required and files larger than 20 MB are rejected.

When employeeAccess is omitted, the server defaults employee-visible access to read-only for employee documents. The created response includes the generated file token and current signature requirement flags.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Identifier of the company that employs the employee.

employeeId

int32

required

Identifier of the employee who will own the uploaded document.

Body Params

file

Uploaded document binary content.

caption

string

length between 0 and 100

Optional user-facing caption shown for the stored document. The value is limited to 100 characters.

docType

int32

enum

Numeric enum describing the business document category used by the v1 document contract.

Members:

1 - General ( Generic document without a specialized tax-form workflow. )
2 - W4 ( IRS Form W-4 employee withholding document. )
3 - I9 ( Form I-9 employment eligibility verification document. )
4 - Form8850 ( IRS Form 8850 pre-screening notice and certification request. )
5 - EnrollmentConfirmDoc ( Enrollment confirmation document. )
6 - W9 ( IRS Form W-9 taxpayer identification request. )

Allowed:

note

string

Optional note stored together with the document.

employeeAccess

int32

enum

Numeric enum describing the employee access level assigned to an uploaded document.

Members:

0 - None ( The employee is not granted access to the document. )
1 - Read ( The employee can access the document with read permissions. )
2 - Write ( The employee can access the document with write permissions. )

Allowed:

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200OK