Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Employers

Create employer

client.employers.create(EmployerCreateParams { address, ein, email, 4 more } body, RequestOptionsoptions?): EmployerResponse { data }
POST/v1/employers

Creates a new employer for the authenticated organization. Requires employer name, legal name, EIN, email, and address information. Returns the created employer with its assigned ID.

ParametersExpand Collapse
body: EmployerCreateParams { address, ein, email, 4 more }
address: Address

Employer address

address_line_1: string

Primary street address

city: string

City name

state: string

Two-letter state code

maxLength2
minLength2
zipcode: string

ZIP code

address_line_2?: string | null

Secondary street address

ein: string

Employer Identification Number (format: XX-XXXXXXX)

maxLength10
minLength10
email: string

Email address for billing and communications

formatemail
name: string

Employer display name

maxLength255
minLength1
phone_number?: string | null

Employer phone number (10-digit US format, e.g. 5551234567)

reference_id?: string | null

External reference ID for this employer

maxLength255
ReturnsExpand Collapse
EmployerResponse { data }

Response containing a single employer resource.

data: Employer { id, active, address, 10 more }

Serializer for Employer entity in public API responses.

id: string

Unique employer identifier with 'empr_' prefix

active: boolean

Whether the employer is currently active in the system

address: Address { address_line_1, city, state, 2 more }

Nested address within EmployerSerializer.

address_line_1: string

Primary street address

city: string

City name

state: string

Two-letter state code (e.g., CA, NY)

zipcode: string

ZIP code (5 or 9 digit)

address_line_2?: string | null

Secondary street address (apt, suite, etc.)

created_at: string

Timestamp when the employer was created

formatdate-time
ein: string | null

Employer Identification Number (masked in responses)

eligibility_policy_id: string | null

ID of the benefit eligibility policy (epol_*), if assigned

name: string

Display name of the employer

organization_id: string | null

ID of the parent organization (org_*)

updated_at: string

Timestamp when the employer was last updated

formatdate-time
email?: string | null

Email address for billing and communications

formatemail
phone_number?: string | null

Employer phone number (E.164 format recommended)

reference_id?: string | null

Partner-assigned reference ID for the employer

Create employer

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const employerResponse = await client.employers.create({
  address: {
    address_line_1: '789 Business Blvd',
    address_line_2: 'Floor 5',
    city: 'Seattle',
    state: 'WA',
    zipcode: '98101',
  },
  ein: '12-3456789',
  email: 'hr@newco.com',
  legal_name: 'NewCo Industries LLC',
  name: 'NewCo Industries',
  phone_number: '2065550100',
  reference_id: 'partner-emp-001',
});

console.log(employerResponse.data);
{
  "data": {
    "id": "empr_new123abc",
    "organization_id": "org_xyz789",
    "name": "NewCo Industries",
    "legal_name": "NewCo Industries LLC",
    "ein": "XX-XXX6789",
    "reference_id": null,
    "email": "hr@newco.com",
    "phone_number": "2065550100",
    "active": true,
    "address": {
      "address_line_1": "789 Business Blvd",
      "address_line_2": "Floor 5",
      "city": "Seattle",
      "state": "WA",
      "zipcode": "98101"
    },
    "eligibility_policy_id": null,
    "created_at": "2024-11-26T10:00:00Z",
    "updated_at": "2024-11-26T10:00:00Z"
  }
}
Returns Examples
{
  "data": {
    "id": "empr_new123abc",
    "organization_id": "org_xyz789",
    "name": "NewCo Industries",
    "legal_name": "NewCo Industries LLC",
    "ein": "XX-XXX6789",
    "reference_id": null,
    "email": "hr@newco.com",
    "phone_number": "2065550100",
    "active": true,
    "address": {
      "address_line_1": "789 Business Blvd",
      "address_line_2": "Floor 5",
      "city": "Seattle",
      "state": "WA",
      "zipcode": "98101"
    },
    "eligibility_policy_id": null,
    "created_at": "2024-11-26T10:00:00Z",
    "updated_at": "2024-11-26T10:00:00Z"
  }
}