Auth Links

Auth Links are links that take the user to a specific Zeal login page. Once the user has logged in, it then redirects the user to another page, such as the taxes dashboard.

Getting an authLink

Use the following endpoints that exist on Zeal's documentation to receive and direct the employer to the respective Auth Link destination:

One endpoint example is the Get Employer Taxes Page authLink endpoint, this endpoint returns an authLink that signs in and directs an employer to their taxes page on the UI. This is an example of a cURL request utilizing this endpoint:

curl --location --request POST '' \
--header 'Authorization: Bearer <token_here>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partnerID" : "c133eed2c9b8419b2222dc059bd445a",
    "companyID" : "8828bcc353334040bfb1ae2d121c0dcb"

The response would return back a link that logins a user in and directs them to a specified page, in this case being the tax page. This an example of a request response:

  "success": true,
  "url": ""

Did this page help you?