---
title: "Company Details"
method: POST
path: "/companies/{company}/components/details"
---

# Company Details

`POST /companies/{company}/components/details`

## Request

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

This Component allows employers to enter information about their business for due diligence review to determine payroll product and feature eligibility
<img style="margin-top: 30px; margin-bottom: 20px;" src="https://public-component-assets.s3.amazonaws.com/er_details.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

## Request body

- object
  - `signer_name` string, required: The name of the person who has permission to onboard on behalf of the company.
  - `signer_title` string, required: The title of the person who has permission to onboard on behalf of the company (e.g. "Officer", "Manager", etc.).
  - `email` string, required: The email of the person who has permission to onboard on behalf of the company
  - `signatory` string: The ID of the signatory object for this company. You may use either a signatory ID or the three body params above
  - `field_permissions` object: Locks company fields in the Component or Onboard flow that this link opens. Each key names a field, and each value sets its access level: `read` shows the field without letting the user edit it, and `read_write` is the default. An unknown key or level returns a 400. Keys that this Component doesn't render are accepted and ignored, so you can send the same map on every link. Check Components enforces the lock in its UI only. The API still accepts writes to a locked field. See [Locking company fields](doc:locking-company-fields).
    - `company:legal_name` 'read' | 'read_write': Access level for the company's legal name.
    - `company:trade_name` 'read' | 'read_write': Access level for the company's trade name.
    - `company:address` 'read' | 'read_write': Access level for the company's legal address. Workplace addresses aren't affected.
    - `company:phone` 'read' | 'read_write': Access level for the company's phone number.
    - `company_tax_param:federal_ein` 'read' | 'read_write': Access level for the company's federal EIN in tax setup.

## Response `201`

201

- 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/details/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)