Employers

Create employer

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.

post/v1/employers

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/employers
  • Auth: HTTP bearer

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Request body

namestring required

Employer display name

legal_namestring required

Legal business name

einstring required

Employer Identification Number (format: XX-XXXXXXX)

emailstring email required

Email address for billing and communications

phone_numberstring nullable

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

reference_idstring nullable

External reference ID for this employer

Response

Changes

No recorded changes to this operation across all 1 revision of this API.