---
title: "Contractor Onboard"
method: POST
path: "/contractors/{contractor}/onboard"
---

# Contractor Onboard

`POST /contractors/{contractor}/onboard`

## Request

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

Generates an Onboard link for the specified contractor.

## Path parameters

- `contractor` 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/contractors/:contractor/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)