Zeal Components
Generate Employee or Contractor Dashboard Link
Generate a link that automatically signs in an employee or contractor and redirects them to their Zeal worker dashboard. This link expires exactly 7 days after generation.
POST
Generate Company Login Link
Generate a link that automatically signs in an employee or contractor and redirects them to their Zeal worker dashboard. This link (and dashboard) can be hosted on your custom domain. When a worker logs out of the dashboard, they will be redirected to the Base URL from your Settings page. This link expires exactly 7 days after generation.
This endpoint shares the
/getAuthLink route with Generate Company Login Link. To generate a worker dashboard link, in addition to the parameters below also pass:- employeeID (string) - ID of the employee to sign in
- contractorID (string) - ID of the contractor to sign in
- use_mfa (boolean) - If true, MFA is required when accessing the worker dashboard
- mfa_methods (string, enum:
email,sms) - If not specified anduse_mfais true, both MFA options are shown
embedded_page accepts dashboard-worker (worker dashboard home), profile-worker (worker profile), or wallet (worker instant pay wallet) to embed a single page without the sidebar.Authorizations
Body
application/json
PartnerID of the Zeal Partner
CompanyID of the company
By specifying the particular page you want to embed, the embedded component will show just that page and no sidebar. Can take the values of dashboard (home page), employees, contractors, custom-attributes, custom-paperwork, i9, or reports.
Available options:
dashboard, employees, contractors, custom-attributes, custom-paperwork, i9, reports