Generate Company Login Link

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

post/getAuthLink

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/getAuthLink/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

partnerIDstring required

PartnerID of the Zeal Partner

companyIDstring required

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.

Response

200

successboolean

urlstring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.