Employers

Submit Payroll Access Setup

Submit the employer's payroll access setup answers.

put/v1/employers/{employer_id}/payroll-access-setup

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/employers/{employer_id}/payroll-access-setup
  • Auth: HTTP bearer

Path parameters

employer_idstring required

Unique employer identifier (empr_*)

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

employees_in_payroll_acknowledgedboolean required

Attestation that all benefit-eligible employees appear in the payroll system.

payroll_data_impacts_eligibility_acknowledgedboolean required

Attestation that changes to payroll data affect benefit eligibility.

classifications_accurateboolean required

Attestation that employee classifications in payroll are accurate. Set false to report corrections in the fields below.

classification_correction_source'ENTER_NAMES' | 'EMAIL_LIST'
  • ENTER_NAMES - ENTER_NAMES
  • EMAIL_LIST - EMAIL_LIST
misclassified_employee_namesstring[]

Names of employees whose payroll classification needs correcting.

remaining_employee_action'VITABLE_UPDATE' | 'EMPLOYER_UPDATE'
  • VITABLE_UPDATE - VITABLE_UPDATE
  • EMPLOYER_UPDATE - EMPLOYER_UPDATE
all_benefit_eligible_employees_presentboolean required

Attestation that every benefit-eligible employee is present in payroll.

missing_employee_resolution'EMAIL_CENSUS' | 'SECOND_SYSTEM_ACCESS'
  • EMAIL_CENSUS - EMAIL_CENSUS
  • SECOND_SYSTEM_ACCESS - SECOND_SYSTEM_ACCESS
is_controlled_groupboolean required

Whether this employer belongs to a controlled group of related entities.

same_payroll_covers_other_einsboolean nullable

Whether this payroll system also covers other EINs in the controlled group.

access_method'SELF_SETUP' | 'NEEDS_HELP' required
  • SELF_SETUP - SELF_SETUP
  • NEEDS_HELP - NEEDS_HELP
login_urlstring nullable

Sign-in URL for the payroll system.

usernamestring nullable

Username Vitable should use to access the payroll system.

phonestring nullable

Phone number used for payroll-system verification codes.

passwordstring nullable

Password Vitable should use to access the payroll system.

integration_confirmedboolean nullable

Whether the payroll integration has been confirmed as working.

has_additional_payroll_systemboolean required

Whether a second payroll system is in use. When true, supply the additional_* fields below.

additional_access_method'SELF_SETUP' | 'NEEDS_HELP'
  • SELF_SETUP - SELF_SETUP
  • NEEDS_HELP - NEEDS_HELP
additional_login_urlstring nullable

Sign-in URL for the second payroll system.

additional_usernamestring nullable

Username Vitable should use for the second payroll system.

additional_phonestring nullable

Phone number used for second payroll-system verification codes.

additional_passwordstring nullable

Password Vitable should use for the second payroll system.

additional_integration_confirmedboolean nullable

Whether the second payroll integration has been confirmed as working.

Response

Changes

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