---
updatedAt: 2025-10-12T20:27:10.000Z
agentTools:
  projectIndex: https://docs.checkhq.com/llms.txt
---

# Company Pay History

This Component allows an employer to input their year-to-date pay history as part of the Embedded Setup process.

<Image align="center" src="https://files.readme.io/0b3f53c39dd074b150c8377dee0bd4adcf152a0f78639aa3fb41128b667be68e-payhistory.gif" />

> 📘 Completion Event
>
> When embedded on your page, this component can be closed once the `check-component-pay-history-complete` SDK event has been posted.

<br />

## Additional SDK Events

Throughout a user's progress in this component, a few other SDK events will be emitted which you have the option to act on. More documentation about SDK events emitted from Check Components can be found [here](https://docs.checkhq.com/docs/handling-component-events).

| Event                                             | Description                                                                                    |
| :------------------------------------------------ | :--------------------------------------------------------------------------------------------- |
| `check-component-pay-history-reopened`            | Indicates when a company re-opens their year-to-date pay history submission to edit their data |
| `check-component-pay-history-payroll-submitted`   | Emits an event when a user successfully submits a historical payroll.                          |
| `check-component-pay-history-payroll-unsubmitted` | Emits an event when a user successfully unsubmits a historical payroll.                        |
| `check-component-pay-history-deleted`             | Emits an event when a user successfully deletes a historical payroll.                          |

<br />

If `email` is provided, the user can regenerate a link sent to that email if the component link is expired.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "check-api",
    "version": "2025-01-01"
  },
  "servers": [
    {
      "url": "https://sandbox.checkhq.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer",
        "x-default": "YOUR_API_KEY"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/companies/{company}/components/pay_history": {
      "post": {
        "summary": "Company Pay History",
        "description": "This Component allows an employer to input their year-to-date pay history as part of the Embedded Setup process.",
        "operationId": "company-pay-history",
        "parameters": [
          {
            "name": "company",
            "in": "path",
            "description": "ID of the company for which a component link will be generated",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "The email of the person who has permission to onboard on behalf of the company"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\"url\":\"{component_url}\"}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string",
                      "example": "{component_url}"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```