> This page is for version Latest Version (default).
> For other versions, use one of these documentation indexes:
> - Latest Version (default): https://paylocity-develop.ferndocs.com/payroll/latest-version/llms.txt
> - v2026-02-17: https://paylocity-develop.ferndocs.com/payroll/v-2026-02-17/llms.txt

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

# Upsert Onboarding Status

PUT https://api.paylocity.com/apiHub/security/v1/companies/{companyId}/companyOnboardingStatuses
Content-Type: application/json

The Partner Onboarding API is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested in exploring partnership opportunities, please contact us at [Techpartnerships@paylocity.com](mailto:Techpartnerships@paylocity.com)

**Summary Description**

The new Partner Onboarding API is designed to enable our partners to onboard customers through our Paylocity Marketplace-initiated workflow. Approved partners will utilize the API to provision a client onto a specific integration. This API provides an endpoint that allows partners to upsert the status of the integration, using the Paylocity companyId specified in the request body. Partners can update the companyOnboardingStatus to one of four options: InProgress, Approved, Rejected or Suspended. If approved the partner will be able to sync the requested client data through the API.

Reference: https://paylocity-develop.ferndocs.com/payroll/api-reference/paylocity-ap-is/partner-onboarding/upsert-onboarding-status

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `companyId` (string, required)

### Headers

- `testMode` (boolean, optional) — If true all responses are mocked and generated randomly.
- `Accept` (string, optional)

## Response

### 200

Successful response

## Examples

**Request**

```json
{
  "companyId": "A00123",
  "onboardingStatus": "Approved"
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://api.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses"

payload = {
    "companyId": "A00123",
    "onboardingStatus": "Approved"
}
headers = {
    "testMode": "true",
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses';
const options = {
  method: 'PUT',
  headers: {
    testMode: 'true',
    Accept: 'application/json',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"companyId":"A00123","onboardingStatus":"Approved"}'
};

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.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses"

	payload := strings.NewReader("{\n  \"companyId\": \"A00123\",\n  \"onboardingStatus\": \"Approved\"\n}")

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

	req.Header.Add("testMode", "true")
	req.Header.Add("Accept", "application/json")
	req.Header.Add("Authorization", "Bearer <token>")
	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.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses")

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

request = Net::HTTP::Put.new(url)
request["testMode"] = 'true'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyId\": \"A00123\",\n  \"onboardingStatus\": \"Approved\"\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.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses")
  .header("testMode", "true")
  .header("Accept", "application/json")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyId\": \"A00123\",\n  \"onboardingStatus\": \"Approved\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses', [
  'body' => '{
  "companyId": "A00123",
  "onboardingStatus": "Approved"
}',
  'headers' => [
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'testMode' => 'true',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses");
var request = new RestRequest(Method.PUT);
request.AddHeader("testMode", "true");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"companyId\": \"A00123\",\n  \"onboardingStatus\": \"Approved\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "testMode": "true",
  "Accept": "application/json",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "companyId": "A00123",
  "onboardingStatus": "Approved"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.paylocity.com/apiHub/security/v1/companies/companyId/companyOnboardingStatuses")! 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()
```