> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Employee Dashboard
> An essential piece of your payroll product is the Employee Dashboard. Employees need a space to review paystubs and payment history, manage their profile information, and review tax information.
## In this guide
* Which endpoints are needed to recreate the Employee Dashboard.
* How to embed the white-label Employee Dashboard in your application.
***
## API
We’ll use **Zeal’s white-labeled Employee Dashboard** as a reference for building our custom dashboard.
### How to build a Home Page
1. Call [Get Employee Checks by Employee](/reference/employee-checks/employee-checks/get-employee-checks-by-employee) to present a summary of checks for this employee.
### Note
Remember to replace the placeholders such as `{{testApiKey}}` in the code samples below.
```bash bash theme={null}
curl --request GET \
--url 'https://api.zeal.com/employeeCheck?companyID={{companyID}}&employeeID={{employeeID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}'
```
2. Call [Get Paystub Link](/reference/zeal-components/get-paystub-link) to allow employees to download specific paystubs.
```bash bash theme={null}
curl --request GET \
--url 'https://api.zeal.com/paystubLink?companyID={{companyID}}&employeeCheckID={{employeeCheckID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}'
```
### How to build a Profile Page
1. Call [Get/Update Employee Information](/reference/employees/get-employee-information) to allow the employee to view/edit their profile information.
```bash bash theme={null}
curl --request GET \
--url 'https://api.zeal.com/employees?companyID={{companyID}}&employeeID={{employeeID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}'
```
2. Call [Get Employee Tax Parameter Summary](/reference/employee-onboarding/get-employee-tax-parameter-summary) and [Set Employee Tax Parameters](/reference/employee-onboarding/set-employee-tax-parameters) allow the employee to view/edit their tax information.
```bash bash theme={null}
curl --request POST \
--url https://api.zeal.com/employees/getTaxParameterSummary \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}' \
--header 'Content-Type: application/json' \
--data '
{
"jurisdictions": [
"US",
"CA"
],
"employeeID": "{{employeeID}}",
"companyID": "{{companyID}}"
}
'
```
3. Call [View/Sign Employee Paperwork](/reference-link/employee-paperwork) to present tax documents (federal & state W-4s) in a PDF format.
```bash bash theme={null}
curl --request POST \
--url https://api.zeal.com/paperwork/employeePaperwork \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}' \
--header 'Content-Type: application/json' \
--data '
{
"jurisdiction": "US",
"companyID": "{{companyID}}",
"employeeID": "{{employeeID}}",
"signature_text": "iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0BqpEAAABRmlDQ1BJQ0MgUHJvZmlscccKJFjYGASSSwoyGFhYGDIzSspCnJ3UoiIjFJgf8bAwiDLwMfAxSCYmFxc4BgQ4ANUwgCjUcG3awyMIPqyLsispF"
}
'
```
4. Call [Get Bank Account by Employee/Contractor ID](/reference/bank-accounts/get-bank-accounts-by-worker-id) to present bank account information. Use [Update Bank Account](/reference/bank-accounts/update-bank-account) to allow the employee to correct their bank information.
```bash bash theme={null}
curl --request GET \
--url 'https://api.zeal.com/bankaccount?companyID={{companyID}}&id={{employeeID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}'
```
### How to build an Employee Documents section
Call [Get Documents](/reference/documents/get-documents) to retrieve a list of employee documents such as W-2s or W-2 Cs.
```bash bash theme={null}
curl --request GET \
--url 'https://api.zeal.com/documents?companyID={{companyID}}&id={{employeeID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}'
```
***
## Zeal's White-Labeled Dashboard
There are two ways to allow an Employee to access their dashboard.
### SSO Link
1. If you’ve already authenticated the employee on your system, call [Generate Employee Dashboard Link](/reference/zeal-components/generate-employee-contractor-dashboard-link) to get an SSO link directly to the employee's dashboard.
```bash bash theme={null}
curl --location --request POST 'https://api.zeal.com/getAuthLink'
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}' \
--header 'Content-Type: application/json'
--data-raw '
{
"partnerID": "{{partnerID}}",
"companyID": "{{companyID}}",
"employeeID": "{{employeeID}}"
}
'
```
2. Now, allow the employee to access the link or embed the component directly in your application through an iframe .
```bash bash theme={null}
Click to begin payroll onboarding!
```
### Login Credentials
During the [Employee Onboarding](/docs/employee-onboarding-guide), include the account creation step by setting `"employee_acct": true`.
```bash bash theme={null}
curl --request POST \
--url https://api.zeal.com/employees/onboard \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}' \
--header 'Content-Type: application/json' \
--data '
{
"profile": true,
"employee_acct": true,
"i9_form": false,
"id_scan": false,
"companyID": "{{companyID}}",
"employeeID": "{{employeeID}}"
}
'
```
2. The employee creates credentials that they can use to log into their Employee Dashboard.
3. The employee navigates to your domain (e.g. payroll.\[your-domain].com) and inputs their credentials to log in.
***
## Recap
* The Employee Dashboard provides core functionality to your payroll products such as allowing employees to access paystubs and personal information.
* All the data and processes needed to build your customer employee dashboard are exposed through Zeal's API endpoints.
* You may embed the white-label Employee Dashboard directly in your application.