---
title: "Employee Onboard"
method: POST
path: "/employees/{employee}/onboard"
---

# Employee Onboard

`POST /employees/{employee}/onboard`

## Request

- Base URL: `https://sandbox.checkhq.com`
- URL: `https://sandbox.checkhq.com/employees/{employee}/onboard`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkhq/apis/check-api/docs/employees/:employee/onboard/post.ts> (a function with typed inputs; its response is checked against the schema)

Generates an Onboard link for the specified employee. Onboard links can also be embedded like Components. Check out our <a href="https://docs.checkhq.com/docs/adding-check-onboard-to-your-application" target="_blank">guide</a> on how to embed them into your app.

## Path parameters

- `employee` string, required

## Response `200`

200

- object
  - `url` string

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `5a54f5eb888b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/checkhq/apis/check-api/changes/employees/:employee/onboard/post.md)

---

[API](https://skmtc.dev/checkhq/apis/check-api.md) - [All operations](https://skmtc.dev/checkhq/apis/check-api/llms.txt) - [OpenAPI document](https://skmtc.dev/checkhq/apis/check-api/revisions/5a54f5eb888b?raw)