> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.vitablehealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.vitablehealth.com/_mcp/server.

# Submit Payroll Access Setup

PUT https://api.vitablehealth.com/v1/employers/{employer_id}/payroll-access-setup
Content-Type: application/json

Submit the employer's payroll access setup answers.

Reference: https://developer.vitablehealth.com/api/employers/submit-payroll-access-setup

## Authentication

- `Authorization` header (bearer token, required) — API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

## Servers

- `https://api.vitablehealth.com` (Production, default)
- `https://api.uat.vitablehealth.com` (UAT)

## Request

### Path parameters

- `employer_id` (string, required) — Unique employer identifier (empr_*)

### Headers

- `X-Vitable-Organization` (string, optional) — 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`.

### Body (application/json)

This endpoint expects a SubmitPayrollAccessSetupRequest.

- `employees_in_payroll_acknowledged` (boolean, required) — Attestation that all benefit-eligible employees appear in the payroll system.
- `payroll_data_impacts_eligibility_acknowledged` (boolean, required) — Attestation that changes to payroll data affect benefit eligibility.
- `classifications_accurate` (boolean, required) — Attestation that employee classifications in payroll are accurate. Set `false` to report corrections in the fields below.
- `all_benefit_eligible_employees_present` (boolean, required) — Attestation that every benefit-eligible employee is present in payroll.
- `is_controlled_group` (boolean, required) — Whether this employer belongs to a controlled group of related entities.
- `access_method` (enum, required) — * `SELF_SETUP` - SELF_SETUP * `NEEDS_HELP` - NEEDS_HELP
  - Allowed values: `SELF_SETUP`, `NEEDS_HELP`
- `has_additional_payroll_system` (boolean, required) — Whether a second payroll system is in use. When `true`, supply the `additional_*` fields below.
- `classification_correction_source` (enum, optional, nullable) — Where corrected classifications come from, when `classifications_accurate` is `false`.
  - Allowed values: `ENTER_NAMES`, `EMAIL_LIST`
- `misclassified_employee_names` (list of string, optional, default: []) — Names of employees whose payroll classification needs correcting.
- `remaining_employee_action` (enum, optional, nullable) — How to handle employees still missing from the payroll system.
  - Allowed values: `VITABLE_UPDATE`, `EMPLOYER_UPDATE`
- `missing_employee_resolution` (enum, optional, nullable) — How any missing employees will be added, when some are absent.
  - Allowed values: `EMAIL_CENSUS`, `SECOND_SYSTEM_ACCESS`
- `same_payroll_covers_other_eins` (boolean, optional, nullable) — Whether this payroll system also covers other EINs in the controlled group.
- `login_url` (string, optional, nullable) — Sign-in URL for the payroll system.
- `username` (string, optional, nullable) — Username Vitable should use to access the payroll system.
- `phone` (string, optional, nullable) — Phone number used for payroll-system verification codes.
- `password` (string, optional, nullable) — Password Vitable should use to access the payroll system.
- `integration_confirmed` (boolean, optional, nullable) — Whether the payroll integration has been confirmed as working.
- `additional_access_method` (enum, optional, nullable) — How Vitable will access the second payroll system.
  - Allowed values: `SELF_SETUP`, `NEEDS_HELP`
- `additional_login_url` (string, optional, nullable) — Sign-in URL for the second payroll system.
- `additional_username` (string, optional, nullable) — Username Vitable should use for the second payroll system.
- `additional_phone` (string, optional, nullable) — Phone number used for second payroll-system verification codes.
- `additional_password` (string, optional, nullable) — Password Vitable should use for the second payroll system.
- `additional_integration_confirmed` (boolean, optional, nullable) — Whether the second payroll integration has been confirmed as working.

## Response

### 200

- `data` (PayrollAccessSetupStatus, required) — Current status of the employer's payroll access setup.

## Errors

### 400 Bad Request Error

Bad Request - Invalid input or validation error

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 401 Unauthorized Error

Unauthorized - Invalid or missing API key

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 403 Forbidden Error

Forbidden - Insufficient permissions for this resource

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 404 Not Found Error

Not Found - The requested resource does not exist

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 409 Conflict Error

Conflict - Resource already exists or conflicts with current state

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 429 Too Many Requests Error

Too Many Requests - Rate limit exceeded

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 500 Internal Server Error

Internal Server Error - An unexpected error occurred

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 502 Bad Gateway Error

Bad Gateway - External service error

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

## Types

### PayrollAccessSetupStatus

- `completed` (boolean, required) — Whether payroll access setup has been completed for this employer.
- `submitted_at` (datetime, required, nullable) — When the setup form was submitted (RFC 3339), or `null` if it has not been submitted.

## Examples

**Request**

```json
{
  "employees_in_payroll_acknowledged": true,
  "payroll_data_impacts_eligibility_acknowledged": true,
  "classifications_accurate": true,
  "all_benefit_eligible_employees_present": true,
  "is_controlled_group": true,
  "access_method": "SELF_SETUP",
  "has_additional_payroll_system": true
}
```

**Response**

```json
{
  "data": {
    "completed": true,
    "submitted_at": "2024-01-15T09:30:00Z"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup"

payload = {
    "employees_in_payroll_acknowledged": True,
    "payroll_data_impacts_eligibility_acknowledged": True,
    "classifications_accurate": True,
    "all_benefit_eligible_employees_present": True,
    "is_controlled_group": True,
    "access_method": "SELF_SETUP",
    "has_additional_payroll_system": True
}
headers = {
    "Authorization": "Bearer <apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <apiKey>', 'Content-Type': 'application/json'},
  body: '{"employees_in_payroll_acknowledged":true,"payroll_data_impacts_eligibility_acknowledged":true,"classifications_accurate":true,"all_benefit_eligible_employees_present":true,"is_controlled_group":true,"access_method":"SELF_SETUP","has_additional_payroll_system":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup"

	payload := strings.NewReader("{\n  \"employees_in_payroll_acknowledged\": true,\n  \"payroll_data_impacts_eligibility_acknowledged\": true,\n  \"classifications_accurate\": true,\n  \"all_benefit_eligible_employees_present\": true,\n  \"is_controlled_group\": true,\n  \"access_method\": \"SELF_SETUP\",\n  \"has_additional_payroll_system\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employees_in_payroll_acknowledged\": true,\n  \"payroll_data_impacts_eligibility_acknowledged\": true,\n  \"classifications_accurate\": true,\n  \"all_benefit_eligible_employees_present\": true,\n  \"is_controlled_group\": true,\n  \"access_method\": \"SELF_SETUP\",\n  \"has_additional_payroll_system\": true\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup")
  .header("Authorization", "Bearer <apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employees_in_payroll_acknowledged\": true,\n  \"payroll_data_impacts_eligibility_acknowledged\": true,\n  \"classifications_accurate\": true,\n  \"all_benefit_eligible_employees_present\": true,\n  \"is_controlled_group\": true,\n  \"access_method\": \"SELF_SETUP\",\n  \"has_additional_payroll_system\": true\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup', [
  'body' => '{
  "employees_in_payroll_acknowledged": true,
  "payroll_data_impacts_eligibility_acknowledged": true,
  "classifications_accurate": true,
  "all_benefit_eligible_employees_present": true,
  "is_controlled_group": true,
  "access_method": "SELF_SETUP",
  "has_additional_payroll_system": true
}',
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"employees_in_payroll_acknowledged\": true,\n  \"payroll_data_impacts_eligibility_acknowledged\": true,\n  \"classifications_accurate\": true,\n  \"all_benefit_eligible_employees_present\": true,\n  \"is_controlled_group\": true,\n  \"access_method\": \"SELF_SETUP\",\n  \"has_additional_payroll_system\": true\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "employees_in_payroll_acknowledged": true,
  "payroll_data_impacts_eligibility_acknowledged": true,
  "classifications_accurate": true,
  "all_benefit_eligible_employees_present": true,
  "is_controlled_group": true,
  "access_method": "SELF_SETUP",
  "has_additional_payroll_system": true
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.vitablehealth.com/v1/employers/empr_abc123def456/payroll-access-setup")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```