API Reference

Records a signature entry for an employee document.

post
https://example.com/wep/companies//employees//documents//sign

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

Provide either a signature image file or a textual signature in signByText. The signature is stored as an audit entry; it does not alter the downloadable document binary.

The system records the signer identity, source IP address, and timestamp. onBehalfEEId is only meaningful when an admin signs on behalf of another employee.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Identifier of the company that employs the employee.

int32
required

Identifier of the employee who owns the document being signed.

int32
required

Identifier of the document that should receive the signature audit entry.

Body Params
file

Optional signature image file uploaded as part of the multipart request.

string

Optional typed signature text used instead of an image upload.

string

Full name that should be stored with the signature record.

int32

Optional employee identifier used when an admin signs on behalf of someone else.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Response
200

OK

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 1 month ago