Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Update Company Information

Update the Company Object

patch/companies

Request body

companyIDstring required

Company ID of the employer (you can access companyID on the Zeal dashboard)

first_namestring

First name of business owner or administrator.

last_namestring

Last name of business owner or administrator.

emailstring

Email address of business.

business_namestring

Business Name of company

business_phonestring

Phone number of company

business_addressstring

Street address of company's business address

business_citystring

City of company's business address

business_statestring

State of company's business address

business_zipstring

Zip code of company's business address

mail_addressstring

Mailing address of company

mail_citystring

Mailing city of company

mail_statestring

Mailing state of company

mail_zipstring

Mailing zip code of company

ssnstring

SSN of the primary business owner.

ownership_percentageinteger

The ownership percentage held by the primary business owner.

legal_structure'ccorp' | 'corp' | 'estate' | 'foreign_entity' | 'llc' | 'llp' | 'lp' | 'nonprofit' | 'partnership' | 'scheme' | 'scorp' | 'soleprop' | 'trust'

The legal structure of the business.

job_titlestring

The job title of the primary business owner.

dobstring

Date of birth of the primary business owner. This should be in theMM/DD/YYYY format.

addressstring

Address of the primary business owner.

address_line2string

Address line 2 of the primary business owner.

citystring

City of the primary business owner.

statestring

State of the primary business owner.

zipstring

Zip code of the primary business owner.

payroll_schedule'daily' | 'weekly' | 'biweekly' | 'semimonthly' | 'monthly'

The default payroll schedule that the company follows

payroll_firstDatestring

The ISO-8601 date of the first regular payroll

payroll_firstPayPeriodIDstring

Reporting period ID of the first regular payroll

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "companyID": "1e2wu23273238c22ea2",
    "first_name": "Richard",
    "last_name": "Hendricks",
    "email": "richard@piedpiper.com",
    "business_name": "Pied Piper",
    "business_address": "1 Market St.",
    "business_city": "San Francisco",
    "business_state": "CA",
    "business_zip": "94110",
    "business_phone": "2025550151",
    "mail_address": "1 Market St.",
    "mail_city": "San Francisco",
    "mail_state": "CA",
    "mail_zip": "94110",
    "ssn": "22-333-4444",
    "ownership_percentage": 25,
    "dob": "01/01/1990",
    "legal_structure": "ccorp",
    "job_title": "CEO",
    "address": "1 Ferry Building",
    "city": "San francisco",
    "state": "CA",
    "zip": "94105",
    "payroll_firstCheckDate": "2024-08-30",
    "payroll_schedule": "weekly",
    "payroll_firstPayPeriodID": "6580ce4a3808d60023b4e412"
  }
}