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

Create employer

employers.create(EmployerCreateParams**kwargs) -> EmployerResponse
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
address: Address

Employer address

address_line_1: str

Primary street address

city: str

City name

state: str

Two-letter state code

maxLength2
minLength2
zipcode: str

ZIP code

address_line_2: Optional[str]

Secondary street address

ein: str

Employer Identification Number (format: XX-XXXXXXX)

maxLength10
minLength10
email: str

Email address for billing and communications

formatemail
name: str

Employer display name

maxLength255
minLength1
phone_number: Optional[str]

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

reference_id: Optional[str]

External reference ID for this employer

maxLength255
ReturnsExpand Collapse
class EmployerResponse: …

Response containing a single employer resource.

data: Employer

Serializer for Employer entity in public API responses.

id: str

Unique employer identifier with 'empr_' prefix

active: bool

Whether the employer is currently active in the system

address: Address

Nested address within EmployerSerializer.

address_line_1: str

Primary street address

city: str

City name

state: str

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

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

created_at: datetime

Timestamp when the employer was created

formatdate-time
ein: Optional[str]

Employer Identification Number (masked in responses)

eligibility_policy_id: Optional[str]

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

name: str

Display name of the employer

organization_id: Optional[str]

ID of the parent organization (org_*)

updated_at: datetime

Timestamp when the employer was last updated

formatdate-time
email: Optional[str]

Email address for billing and communications

formatemail
phone_number: Optional[str]

Employer phone number (E.164 format recommended)

reference_id: Optional[str]

Partner-assigned reference ID for the employer

Create employer

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
employer_response = 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",
)
print(employer_response.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"
  }
}