CHcheckhq

Get a company

Changed on

Returns the specified company.

get/companies/{company}

Request

Path parameters

companystring required

ID of the company to return

Response

200

idstring
legal_namestring
trade_namestring
other_business_namestring
business_typestring
industry_typestring
websitestring
emailstring
phonestring
pay_frequencystring
bank_accountsstring[]
statement_descriptorstring
activeboolean
principal_place_of_businessstring
in_good_standingboolean
processing_periodstring
start_datestring
metadataobject
employee_w2_delivery_methodstring
contractor_1099_delivery_methodstring
processing_period_eligibilitystring[] nullable
default_bank_accountstring

Example response

{
  "id": "com_H4eYDq9imaA5Ur3qwKA0",
  "legal_name": "Stark Industries, Inc.",
  "trade_name": "Stark Industries",
  "phone": "1234567890",
  "pay_frequency": "biweekly",
  "bank_accounts": [
    "bnk_iPiAA7RDadr3gGMa2cvq"
  ],
  "active": true,
  "address": {
    "line1": "200 Park Ave",
    "city": "New York",
    "state": "NY",
    "postal_code": "10166",
    "country": "US"
  },
  "onboard": {
    "status": "completed"
  },
  "implementation": {
    "status": "needs_attention",
    "remaining_steps": {
      "kyb": {
        "status": "not_initiated"
      }
    }
  },
  "in_good_standing": true,
  "processing_period": "three_day",
  "start_date": "2020-05-20",
  "employee_w2_delivery_method": "manual",
  "contractor_1099_delivery_method": "manual",
  "processing_period_eligibility": [
    "three_day",
    "two_day",
    "one_day"
  ],
  "default_bank_account": "bnk_iPiAA7RDadr3gGMa2cvq"
}

Changes