Skip to main content
POST
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 (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. Pass employeeID or contractorID (not both required, but at least one) to generate a worker dashboard link.For worker links, embedded_page must be one of dashboard-worker, profile-worker, or wallet (not the company dashboard values). Optional use_mfa and mfa_methods apply only to worker links.

Authorizations

Authorization
string
header
required

Body

application/json
partnerID
string
required

PartnerID of the Zeal Partner

companyID
string
required

CompanyID of the company

employeeID
string

ID of the employee to sign in

contractorID
string

ID of the contractor to sign in

embedded_page
enum<string>

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-worker (worker dashboard home page), profile-worker (worker profile page), or wallet (worker instant pay wallet).

Available options:
dashboard-worker,
profile-worker,
wallet
use_mfa
boolean
default:false

If true, MFA is required when accessing the worker dashboard

mfa_methods
enum<string>[]

If not specified and use_mfa is true, both MFA options are shown

Available options:
email,
sms

Response

200

success
boolean
default:true
Example:

true

url
string
Example:

"https://payroll.your-domain.com/auth?accessToken=<accessToken>"