---
updatedAt: 2026-09-14T11:07:44.000Z
agentTools:
  projectIndex: https://docs.checkhq.com/llms.txt
---

# Company Progress Tracker Component

Generates a Full Service Setup Progress Tracker component used to monitor Check's progress in setting up a Full Service Setup Company and allows users to resolve potential blocking issues raised by Check operators during the setup process.

<Image align="center" className="border" width="500px" border={true} src="https://files.readme.io/b38296dae5c2a7deb81fbf8985ac1763726e3149613ad5a020b264b0da876326-Screenshot_2024-10-23_at_5.24.00_PM.png" />

> ❗️ Slated for deprecation
>
> This component is only available with Check Embedded Setup, which is slated for deprecation on **January 1, 2027**. Reach out to Check with questions about migrating.

<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/progress_tracker": {
      "post": {
        "summary": "Company Progress Tracker Component",
        "description": "Generates a Full Service Setup Progress Tracker component used to monitor Check's progress in setting up a Full Service Setup Company and allows users to resolve potential blocking issues raised by Check operators during the setup process.",
        "operationId": "company-progress-tracker",
        "parameters": [
          {
            "name": "company",
            "in": "path",
            "description": "ID of the company for which an onboard 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\":\"{one_time_onboard_link}\"}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string",
                      "example": "{one_time_onboard_link}"
                    }
                  }
                }
              }
            }
          },
          "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
}
```