Companies
Create Company
Create a new employer company under your Zeal partner account. Returns a companyID used in all subsequent company and payroll API calls.
POST
/
companies
Create Company
curl --request POST \
--url https://api.zeal.com/companies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"partnerID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_ein": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"business_phone": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"dob": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"skip_migration": false,
"job_title": "<string>",
"address_line2": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>",
"physical_address": "<string>",
"physical_city": "<string>",
"physical_state": "<string>",
"physical_zip": "<string>"
}
'import requests
url = "https://api.zeal.com/companies"
payload = {
"partnerID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_ein": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"business_phone": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"dob": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"skip_migration": False,
"job_title": "<string>",
"address_line2": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>",
"physical_address": "<string>",
"physical_city": "<string>",
"physical_state": "<string>",
"physical_zip": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partnerID: '<string>',
first_name: '<string>',
last_name: '<string>',
email: '<string>',
business_name: '<string>',
business_ein: '<string>',
business_address: '<string>',
business_city: '<string>',
business_state: '<string>',
business_zip: '<string>',
business_phone: '<string>',
mail_address: '<string>',
mail_city: '<string>',
mail_state: '<string>',
mail_zip: '<string>',
ssn: '<string>',
ownership_percentage: 123,
dob: '<string>',
address: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
skip_migration: false,
job_title: '<string>',
address_line2: '<string>',
payroll_firstDate: '<string>',
payroll_firstPayPeriodID: '<string>',
physical_address: '<string>',
physical_city: '<string>',
physical_state: '<string>',
physical_zip: '<string>'
})
};
fetch('https://api.zeal.com/companies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'partnerID' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'business_name' => '<string>',
'business_ein' => '<string>',
'business_address' => '<string>',
'business_city' => '<string>',
'business_state' => '<string>',
'business_zip' => '<string>',
'business_phone' => '<string>',
'mail_address' => '<string>',
'mail_city' => '<string>',
'mail_state' => '<string>',
'mail_zip' => '<string>',
'ssn' => '<string>',
'ownership_percentage' => 123,
'dob' => '<string>',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'skip_migration' => false,
'job_title' => '<string>',
'address_line2' => '<string>',
'payroll_firstDate' => '<string>',
'payroll_firstPayPeriodID' => '<string>',
'physical_address' => '<string>',
'physical_city' => '<string>',
'physical_state' => '<string>',
'physical_zip' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/companies"
payload := strings.NewReader("{\n \"partnerID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_ein\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"skip_migration\": false,\n \"job_title\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"physical_city\": \"<string>\",\n \"physical_state\": \"<string>\",\n \"physical_zip\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/companies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"partnerID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_ein\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"skip_migration\": false,\n \"job_title\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"physical_city\": \"<string>\",\n \"physical_state\": \"<string>\",\n \"physical_zip\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partnerID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_ein\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"skip_migration\": false,\n \"job_title\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"physical_city\": \"<string>\",\n \"physical_state\": \"<string>\",\n \"physical_zip\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"companyID": "1ea89873acdae98734b2f06c5d7e4a19",
"status": "initial_onboarding",
"first_name": "richard",
"last_name": "hendricks",
"email": "richard@piedpiper.com",
"business_name": "Pied Piper",
"business_ein": "073647583",
"business_address": "1 Market St.",
"business_city": "San Francisco",
"business_state": "CA",
"business_zip": "94110",
"skip_migration": false,
"business_phone": "2025550151",
"mail_address": "1 Market St.",
"mail_city": "San Francisco",
"mail_state": "CA",
"mail_zip": "94110",
"requirements": [],
"account_number": null,
"routing_number": null,
"is_sandbox": true,
"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",
"company_type": "all",
"product_type": "payroll",
"onboarding_url": "/employeronboard/1ea89873acdae98734b2f06c5d7e4a19?companyID=1ea89873acdae98734b2f06c5d7e4a19&classification=TEST",
"payroll_firstCheckDate": "2024-08-30",
"payroll_schedule": "weekly",
"payroll_firstPayPeriodID": "6580ce4a3808d60023b4e412"
}
}This endpoint registers a new employer company under your Zeal partner account and returns a
companyID you will use in every subsequent API call for that company. See The Company Object for the full field reference.Body
application/json
⌘I
Create Company
curl --request POST \
--url https://api.zeal.com/companies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"partnerID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_ein": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"business_phone": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"dob": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"skip_migration": false,
"job_title": "<string>",
"address_line2": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>",
"physical_address": "<string>",
"physical_city": "<string>",
"physical_state": "<string>",
"physical_zip": "<string>"
}
'import requests
url = "https://api.zeal.com/companies"
payload = {
"partnerID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_ein": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"business_phone": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"dob": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"skip_migration": False,
"job_title": "<string>",
"address_line2": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>",
"physical_address": "<string>",
"physical_city": "<string>",
"physical_state": "<string>",
"physical_zip": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partnerID: '<string>',
first_name: '<string>',
last_name: '<string>',
email: '<string>',
business_name: '<string>',
business_ein: '<string>',
business_address: '<string>',
business_city: '<string>',
business_state: '<string>',
business_zip: '<string>',
business_phone: '<string>',
mail_address: '<string>',
mail_city: '<string>',
mail_state: '<string>',
mail_zip: '<string>',
ssn: '<string>',
ownership_percentage: 123,
dob: '<string>',
address: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
skip_migration: false,
job_title: '<string>',
address_line2: '<string>',
payroll_firstDate: '<string>',
payroll_firstPayPeriodID: '<string>',
physical_address: '<string>',
physical_city: '<string>',
physical_state: '<string>',
physical_zip: '<string>'
})
};
fetch('https://api.zeal.com/companies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'partnerID' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'business_name' => '<string>',
'business_ein' => '<string>',
'business_address' => '<string>',
'business_city' => '<string>',
'business_state' => '<string>',
'business_zip' => '<string>',
'business_phone' => '<string>',
'mail_address' => '<string>',
'mail_city' => '<string>',
'mail_state' => '<string>',
'mail_zip' => '<string>',
'ssn' => '<string>',
'ownership_percentage' => 123,
'dob' => '<string>',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'skip_migration' => false,
'job_title' => '<string>',
'address_line2' => '<string>',
'payroll_firstDate' => '<string>',
'payroll_firstPayPeriodID' => '<string>',
'physical_address' => '<string>',
'physical_city' => '<string>',
'physical_state' => '<string>',
'physical_zip' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/companies"
payload := strings.NewReader("{\n \"partnerID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_ein\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"skip_migration\": false,\n \"job_title\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"physical_city\": \"<string>\",\n \"physical_state\": \"<string>\",\n \"physical_zip\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/companies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"partnerID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_ein\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"skip_migration\": false,\n \"job_title\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"physical_city\": \"<string>\",\n \"physical_state\": \"<string>\",\n \"physical_zip\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partnerID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_ein\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"skip_migration\": false,\n \"job_title\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"physical_city\": \"<string>\",\n \"physical_state\": \"<string>\",\n \"physical_zip\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"companyID": "1ea89873acdae98734b2f06c5d7e4a19",
"status": "initial_onboarding",
"first_name": "richard",
"last_name": "hendricks",
"email": "richard@piedpiper.com",
"business_name": "Pied Piper",
"business_ein": "073647583",
"business_address": "1 Market St.",
"business_city": "San Francisco",
"business_state": "CA",
"business_zip": "94110",
"skip_migration": false,
"business_phone": "2025550151",
"mail_address": "1 Market St.",
"mail_city": "San Francisco",
"mail_state": "CA",
"mail_zip": "94110",
"requirements": [],
"account_number": null,
"routing_number": null,
"is_sandbox": true,
"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",
"company_type": "all",
"product_type": "payroll",
"onboarding_url": "/employeronboard/1ea89873acdae98734b2f06c5d7e4a19?companyID=1ea89873acdae98734b2f06c5d7e4a19&classification=TEST",
"payroll_firstCheckDate": "2024-08-30",
"payroll_schedule": "weekly",
"payroll_firstPayPeriodID": "6580ce4a3808d60023b4e412"
}
}