---
title: "Generate Employee Onboarding Link"
method: POST
path: "/employees/onboard"
---

# Generate Employee Onboarding Link

`POST /employees/onboard`

Generates an expirable link to Zeal's employee payroll onboarding for a specified employee.

## Request body

- object
  - `companyID` string, required — Company ID of employer
  - `employeeID` string, required — ID of Employee
  - `employee_acct` boolean — If false, the employee account information (username and password) collection step of the onboarding will be left out
  - `survey` boolean — If false, the employee survey step will be left out (Early Access)
  - `i9_form` boolean — If false, the I9 form in the paperwork step of the onboarding will be left out
  - `id_scan` boolean — If false, the ID scan step of the onboarding will be left out.
  - `payment_method_required` boolean — If false, the onboarding worker will be able to skip the bank account collection section of onboarding
  - `paycard` boolean — If false, the paycard enrollment screen will be left out. NOTE: Only applicable for Paycards (Early Access)
  - `instant_pay` boolean — If false, the instant pay enrollment screen will be left out. NOTE: Only applicable for Instant Pay (Early Access)

## Response `200`

200

- object
  - `success` boolean
  - `data` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zeal/apis/zeal-api.md) · [All operations](https://skmtc.net/zeal/apis/zeal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeal/zeal-api/revisions/01346dceb27d/schema)