API Reference

Retrieve user's documents info
This endpoint returns a list of documents for the user.  The returned list will be determined by the permissions/access of the API client. GET api/libra...
Thu, 7 Dec, 2023 at 10:54 AM
Retrieving all dependant types for a Tenant
This endpoint returns a list of dependant types for the requested tenant.  GET    /api/static/dependants/types/get/{tenantId:int} Request U...
Mon, 13 Nov, 2023 at 3:56 PM
Retrieving all dependants for a specific employee
This endpoint returns a list of all dependants for an employee.  The returned list will be determined by the permissions/access of the API client. GET  ...
Thu, 7 Aug, 2025 at 4:08 PM
Retrieving the Gender List
This endpoint returns a list of all genders held on the platform.  The returned list will be determined by the permissions/access of the API client. GE...
Mon, 13 Nov, 2023 at 3:57 PM
Soft Delete Dependant With Document
All API end points are protected and you will need a bearer token to send to the end point before you will be permitted access.  To obtain a bearer token yo...
Wed, 3 Sep, 2025 at 11:10 AM
Update User Document Category
this endpoint allows you to set the category of a document belonging to a system user. POST    /api/library/documents/update See How to create AP...
Tue, 4 Jun, 2024 at 10:49 AM
Upload file
All API end points are protected and you will need a bearer token to send to the end point before you will be permitted access.  To obtain a bearer token y...
Fri, 1 Aug, 2025 at 3:35 PM
Upload user documents
This endpoint allows you to upload a file (streamed content) to the user's library. POST    /api/file/upload/admin/for-client/store See How t...
Tue, 14 Nov, 2023 at 1:32 PM