---
title: "Run Payroll"
method: POST
path: "/companies/{company}/components/run_payroll (COPY)"
---

# Run Payroll

`POST /companies/{company}/components/run_payroll (COPY)`

## Request

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

Run payroll using our white-labeled Run Payroll Component. Set up employee pay, add earnings, and preview payrolls all within one Component. In order to run payroll with the Component, the company must have:<li>At least one employee associated with it</li><li>At least one pay schedule associated with it (<a href="https://docs.checkhq.com/reference/create-a-pay-schedule">Pay Schedule API</a>)</li><li>Company Onboarding status in "completed" state</li><img style="margin-top: 20px; border-radius: 10px;  border: 1px solid #E2E8F0;"  src="https://public-component-assets.s3.amazonaws.com/run_payroll_v2.svg" />Learn how to embed Components in our <a target="_blank" href="https://docs.checkhq.com/docs/embedding-a-component">guide</a>.

## Path parameters

- `company` string, required

## Query parameters

- `payroll` string

## 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/companies/:company/components/run_payroll%20%28COPY%29/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)