Submit Payroll Access Setup

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

Submit the employer’s payroll access setup answers.

Path ParametersExpand Collapse

employer_id: string

Unique employer identifier (empr_*)

Body ParametersJSONExpand Collapse

access_method: "SELF_SETUP" or "NEEDS_HELP"

SELF_SETUP - SELF_SETUP
NEEDS_HELP - NEEDS_HELP

One of the following:

"SELF_SETUP"

"NEEDS_HELP"

all_benefit_eligible_employees_present: boolean

classifications_accurate: boolean

employees_in_payroll_acknowledged: boolean

has_additional_payroll_system: boolean

is_controlled_group: boolean

payroll_data_impacts_eligibility_acknowledged: boolean

additional_access_method: optional "SELF_SETUP" or "NEEDS_HELP"

SELF_SETUP - SELF_SETUP
NEEDS_HELP - NEEDS_HELP

One of the following:

"SELF_SETUP"

"NEEDS_HELP"

additional_integration_confirmed: optional boolean

additional_login_url: optional string

maxLength2048

additional_password: optional string

maxLength979

additional_phone: optional string

maxLength64

additional_username: optional string

maxLength255

classification_correction_source: optional "ENTER_NAMES" or "EMAIL_LIST"

ENTER_NAMES - ENTER_NAMES
EMAIL_LIST - EMAIL_LIST

One of the following:

"ENTER_NAMES"

"EMAIL_LIST"

integration_confirmed: optional boolean

login_url: optional string

maxLength2048

misclassified_employee_names: optional array of string

missing_employee_resolution: optional "EMAIL_CENSUS" or "SECOND_SYSTEM_ACCESS"

EMAIL_CENSUS - EMAIL_CENSUS
SECOND_SYSTEM_ACCESS - SECOND_SYSTEM_ACCESS

One of the following:

"EMAIL_CENSUS"

"SECOND_SYSTEM_ACCESS"

password: optional string

maxLength979

phone: optional string

maxLength64

remaining_employee_action: optional "VITABLE_UPDATE" or "EMPLOYER_UPDATE"

VITABLE_UPDATE - VITABLE_UPDATE
EMPLOYER_UPDATE - EMPLOYER_UPDATE

One of the following:

"VITABLE_UPDATE"

"EMPLOYER_UPDATE"

same_payroll_covers_other_eins: optional boolean

username: optional string

maxLength255

ReturnsExpand Collapse

data: { completed, submitted_at }

completed: boolean

submitted_at: string

formatdate-time

Submit Payroll Access Setup

curl https://api.vitablehealth.com/v1/employers/$EMPLOYER_ID/payroll-access-setup \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY" \
    -d '{
          "access_method": "SELF_SETUP",
          "all_benefit_eligible_employees_present": true,
          "classifications_accurate": true,
          "employees_in_payroll_acknowledged": true,
          "has_additional_payroll_system": true,
          "is_controlled_group": true,
          "payroll_data_impacts_eligibility_acknowledged": true
        }'

{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}

Returns Examples

{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}