Represents an employer.
The company object captures company payroll information, including payment frequency, bank account information, processing period, and Check onboarding status.
{
"id": "com_sx3svU6K8c5ZkSFlOh5p",
"legal_name": "Stark Industries, Inc.",
"trade_name": "Stark Industries",
"statement_descriptor": "Stark Industries",
"business_type": "c_corporation",
"industry_type": "scientific_and_technical_services",
"website": "https://www.starkindustries.com",
"email": "[email protected]",
"phone": "5551234567",
"pay_frequency": "biweekly",
"bank_accounts": [],
"active": false,
"processing_period": "three_day",
"start_date": "2021-02-15",
"onboard": {
"status": "blocking",
"blocking_steps": [
"bank_account",
"setup_parameters",
"filing_authorization"
],
"remaining_steps": [
"bank_account",
"setup_parameters",
"filing_authorization"
],
"bank_account": [
"bank_account_exists",
"bank_account_verified",
"bank_account_debit_authorization_submitted"
],
"setup_parameters": [
{
"id": "jur_NvIot3gvbIitui4Vmy9Z",
"name": "Federal",
"status": "blocking"
},
{
"id": "jur_87N4QWPZ38kDSvkqAI7D",
"name": "New York",
"status": "needs_attention",
},
],
"filing_authorization": [
{
"id": "frm_ozhx2ezrVsd2k2ScL7HU",
"name": "Federal Form 8655",
"status": "blocking",
},
{
"id": "frm_Iee3dIFvT1uBUYJ4PG7z",
"name": "New York TR-2000",
"status": "needs_attention",
},
{
"id": "frm_Y43LpYf60wEf3bCaN9Rn",
"name": "New York TR-579-WT",
"status": "needs_attention",
},
],
},
"implementation": {
"status": "needs_attention",
"remaining_steps": {
"kyb": {
"status": "not_initiated",
},
},
},
"in_good_standing": true,
"address": {
"line1": "200 Park Ave",
"line2": null,
"city": "New York",
"state": "NY",
"postal_code": "10166",
"country": "US"
},
"principal_place_of_business": "wrk_kf7VlAT2024bG3ibQ1Kf",
"employee_w2_delivery_method": null,
"contractor_1099_delivery_method": null,
"metadata": {},
"default_bank_account": "bnk_v65m1wAKyyOYm37fLieP"
}Attribute | Description |
|---|---|
id string | Unique identifier for the company. |
legal_name | Legal name of the company. Cannot be updated unless |
trade_name | Trade name of the company. |
other_business_name | Other business name used by the company. |
statement_descriptor | Business name that will be included as part of ACH/RTP transactions for employee and contractor direct deposits, which will be displayed on employee bank statements. Maximum of 16 characters. If not provided, will default to the Check partner's originator name if provided, or "Check Payroll" if not. |
business_type | Business type of the company. One of |
industry_type | Industry type of the company. One of |
website | Website URL of the company. |
email | Email address of payroll department or administrator. |
phone | Phone number of the company. |
pay_frequency | Frequency by which the employees get paid. One of Defaults to |
bank_accounts | Read only. An array of bank account IDs. (Multiple bank accounts for a company is not yet supported, so this array will always have length 1). |
active | Indicates whether the company is active or archived within Check. |
processing_period | Number of days from payroll approval to payday. Following Check's risk review, companies are assigned one of the following values: For |
start_date | Date the company will start using Check as their payroll processor. This date should match up with their first payday using Check. The validity of this date is important, as it's used on federal and state filing authorization forms to signify when Check's authorization to file on behalf of the employer starts. |
onboard | Structured information about the onboard status of the company. |
implementation | Structured information about the implementation status of the company. |
in_good_standing | Indicates if the company is considered to be In Good Standing with Check. As an example, if a company is delinquent on payments they would be marked Any company which is not in good standing will not be able to run payroll. |
address | Legal address of company on file with the federal government. Cannot be updated unless |
principal_place_of_business | Company's workplace ID whose address would be printed on paystub, instead of legal address. |
employee_w2_delivery_method | Indicates how a company would like to deliver W-2s to employees. Set to |
contractor_1099_delivery_method | Indicates how a company would like to deliver 1099s to contractors. Set to |
metadata | Additional loosely structured information to associate with the company. |
default_bank_account | ID of the default bank account of the company. The default bank account is used for employer tax collections and refunds, as well as to fund payrolls unless the user explicitly sets the The default bank account can be updated to be any one of the company's active bank accounts. |
