| 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 an employee and redirects them to their Zeal Employee Dashboard. This link (and dashboard) can be hosted on your custom domain. When an employee logs out of the dashboard, they will be redirected to the Base URL from your Settings page.

NOTE: This link expires exactly 7 days after generation.

## Returns   
| attribute | type | description |
| --- | --- | --- |
| success | boolean | Response status |
| data | url | A link that directly signs in an Employee |
| errors | array | If `success` is false, contains a list of error objects which consists of:<br>`message`: Error message<br>`code`: Error code as described in [Error codes](https://docs.zeal.com/reference/error-codes) |

### Parameters

- **partnerID**  
  string required  
  ID of the partner

- **companyID**  
  string required  
  ID of the company

- **employeeID**  
  string  
  ID of the employee

- **contractorID**  
  string  
  ID of contractor

- **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-worker` (worker dashboard home page), `profile-worker` (worker profile page), or `wallet` (worker instant pay wallet).  
  Allowed: `dashboard-worker` `profile-worker` `wallet`

- **use_mfa**  
  boolean  
  If true, MFA will be required when accessing the worker dashboard  
  Allowed: true,false

- **mfa_methods**  
  string enum  
  If not specified and `use_mfa` is true, both mfa options will be shown  
  Allowed: `email` `sms`

# API Request Example

```
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:

| Response Code | Description |
| --- | --- |
| 200 | Result |
| 400 | Result |