The company object

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",
    "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": "four_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",  
            },
            {
                "id": "jur_87N4QWPZ38kDSvkqAI7D",
                "name": "New York",  
            },     
        ],
        "filing_authorization": [
            {
                "id": "frm_ozhx2ezrVsd2k2ScL7HU",
                "name": "Federal Form 8655",  
            },
            {
                "id": "frm_Iee3dIFvT1uBUYJ4PG7z",
                "name": "New York TR-2000",  
            },    
            {
                "id": "frm_Y43LpYf60wEf3bCaN9Rn",
                "name": "New York TR-579-WT",  
            },
        ],
    },
    "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",
    "metadata": {}
}
AttributeDescription
id
string
Unique identifier for the company.
legal_name
string
Legal name of the company.
trade_name
string
Trade name of the company.
other_business_name
string
Other business name used by the company.
business_type
string
Business type of the company. One of sole_proprietorship, partnership, c_corporation, s_corporation, or llc.
industry_type
string
Industry type of the company. One of auto_or_machine_sales, auto_or_machine_repair, arts_or_entertainment_or_recreation, cleaning_services, consulting_services, educational_services, family_care_services, financial_services, food_and_beverage_retail_or_wholesale, general_construction_or_general_contracting, health_care, hospitality_or_accommodation, hvac_or_plumbing_or_electrical_contracting, legal_services, non_food_retail_or_wholesale, other, personal_care_services, real_estate, restaurant, scientific_or_technical_services, security_services, tobacco_or_alcohol_sales, or transportation.
website
string
Website URL of the company.
email
string
Email address of payroll department or administrator.
phone
string
Phone number of the company.
pay_frequency
string
Frequency by which the employees get paid. One of weekly, biweekly, semimonthly, monthly, quarterly, or annually.
bank_accounts
array of strings
Read only. An array of bank account IDs.
active
boolean
Indicates whether the company is active or archived within Check.
processing_period
string
Read only. Number of days from payroll approval to paycheck issuing. Possible values are four_day (the default), two_day, and one_day.
start_date
YYYY-MM-DD
Date the company will start using Check as their payroll processor.
onboard
object
Structured information about the onboard status of the company.
implementation
object
Structured information about the implementation status of the company.
in_good_standing
boolean
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 false here.

Any company which is not in good standing will not be able to run or preview payroll.
address
object
Legal address of company on file with the federal government.
principal_place_of_business
string
Company's workplace ID whose address would be printed on paystub, instead of legal address.
metadata
object
Additional loosely structured information to associate with the company.