Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Generate Company Login Link

Generates a link that automatically signs in an employer into their Zeal Company Dashboard.

post/getAuthLink

Request body

partnerIDstring required

PartnerID of the Zeal Partner

companyIDstring required

CompanyID of the company

embedded_page'dashboard' | 'employees' | 'contractors' | 'custom-attributes' | 'custom-paperwork' | 'i9' | 'reports'

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.

Response

200

successboolean
urlstring

Example response

{
  "success": true,
  "url": "https://payroll.your-domain.com/auth?accessToken=<accessToken>"
}