Generate Company Login Link
| Time | Status | User Agent |
|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Generate a link that automatically signs in a company and redirects them to their Zeal Company Dashboard in which they can manage and run payroll. This link (and dashboard) can be hosted on your custom domain as an iframe component. When a company logs out of the dashboard, they will be redirected to the Base URL set in your Settings page.
NOTE: This link can only be generated in production and cannot be generated with a test API key.
This link also expires exactly 7 days after generation.
Returns
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | url | A link that directly signs in a company |
| errors | array | If success is false, contains a list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |
partnerID
string
required
PartnerID of the Zeal Partner
companyID
string
required
CompanyID of the company
embedded_page
string
enum
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.
dashboardemployeescontractorscustom-attributescustom-paperworki9reports
Allowed:
dashboard``employees``contractors``custom-attributes``custom-paperwork``i9``reports
``200 200
``400 400
Updated 7 months ago
ShellNodeRubyPHPPython
xxxxxxxxxx
curl --request POST \
--url https://api.zeal.com/getAuthLink \
--header 'accept: application/json' \
--header 'content-type: application/json'
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200 - Result400 - Result
Updated7 months ago