v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Generate Employee or Contractor Dashboard Link

post/

Request body

partnerIDstring required

ID of the partner

companyIDstring required

ID of the company

employeeIDstring

ID of the employee

contractorIDstring

ID of contractor

embedded_page'dashboard-worker' | 'profile-worker' | 'wallet'

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).

use_mfaboolean

If true, MFA will be required when accessing the worker dashboard

mfa_methods'email' | 'sms'

If not specified and use_mfa is true, both mfa options will be shown

Response

200

successboolean

urlstring

Example response

{
  "success": true,
  "url": "https://app.zeal.com/auth?accessToken=eyJhbGcccccccInR5cCI6IkpXVCJ9.eyJtb2RlbFR5cGUiOiJXb3JrZXIiLCJlbWFpbCI6ImpvbnNtaXRoQGdtYWlsLmNvbSIsImVtcGxveWVlSUQiOiI2NDdlYTA5MWQwYzhhYjM4ODU2NmY3MDEiLCJleHAiOjE2ODczNzczNzgsImlhdCI6MTY4NzI5MDk3OH0.MXl7VS4tudS2LXXXEkVu4r1ohzSakCnyIejhKC_yThA"
}