---
title: "Send Employee Onboarding Link"
method: POST
path: "/sendLink"
---

# Send Employee Onboarding Link

`POST /sendLink`

Sends an employee onboarding link to the specified employee's email.

## Request body

- object
  - `companyID` string, required — Company ID of employer
  - `employees` object[] — Array of Employee objects to be sent onboarding links.
    - `employeeID` string, required — Zeal Employee ID
    - `profile` boolean — If false, the profile information collection step of the onboarding will be left out. **If you are leaving the profile information out, please ensure that you have given all employee information so Zeal can autofill the paperwork. **
    - `employee_acct` boolean — If false, the employee account information (username and password) collection step of the onboarding will be left out
    - `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
    - `paperwork` boolean — If false, the paperwork step of the onboarding will be left out

## Response `200`

200

- object
  - `success` boolean
  - `data` object[]
    - `employeeID` 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/versions/01346dceb27d/schema)