---
title: "Upsert Onboarding Status"
method: POST
path: "/compliance/v1/companies/b6001/clientOnboarding/status"
tags: ["Client Onboarding"]
---

# Upsert Onboarding Status

`POST /compliance/v1/companies/b6001/clientOnboarding/status`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/compliance/v1/companies/b6001/clientOnboarding/status`
- Auth: API key in header `Authorization`

> 🚧 Partner Restricted
> All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. [Please reach out to our team](https://www.paylocity.com/contact/partner-form/) if you would like to discuss partnership opportunities.

**Summary Description**

This endpoint upserts the status of the integration with companyId specified in the body

**Use Cases**

- Partner receives a new client intake form and sends the ‘in progress’ status to Paylocity
- Partner and client already have an existing relationship, partner sends the ‘approved’ status for client to have access to ordering in the recruiting UI 
- Client initiates a new client intake form. Client and partner decide not to move forward with the relationship. Partner sends the ‘rejected’ status

## Headers

- `testMode` boolean
- `Authorization` string, required

## Request body

- ClientOnboardingUpsertRequest: The onboarding request.
  - `companyId` string, nullable: The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. **Allowable Values:** 9 char max
  - `status` 'InProgress' | 'Approved' | 'Rejected' | 'Suspended', nullable: The status to indicate the onboarding stage for a customer where the account form was filled up and is currently under review by your team.

## Response `200`

Returns details of the upsert operation

- ClientOnboardingUpsertResponse: Onboarding Response
  - `upsertResult` UpsertResultDto: Upsert response
    - `inserted` boolean: True if it was inserted, false if it was updated
    - `updated` boolean: True if it was updated, false if it was inserted

## Other responses

- `400`: Bad Request Error - Returns the details of the error
- `401`: Unauthorized
- `415`: Unsupported Media Type - Returns the details of the error

---

[API](https://skmtc.dev/paylocity/apis/background-check-api.md) - [All operations](https://skmtc.dev/paylocity/apis/background-check-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/background-check-api/revisions/8d585de5e05e?raw)