---
title: "Upsert Screening Package"
method: POST
path: "/compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages/{packageId}"
tags: ["Screening Package"]
---

# Upsert Screening Package

`POST /compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages/{packageId}`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages/{packageId}`
- 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**

Upserts information about screening packages for the companyId

**Use Cases**

- Partner wants to send over a screening package for a client, can be when onboarding a new client, or can be when client adds a new package to their company
- Partner wants to make a specific screening package either active or inactive for a client 
- Partner wants to update the price of a client’s screening package 
- Partner wants to add services to a package 
- Partner wants to add a billing code to correlate to a specific BGC package

## Path parameters

- `companyId` string, required
- `packageId` string, required

## Headers

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

## Request body

- ScreeningPackageUpsertRequest: Screening package Upsert Request.
  - `isActive` boolean: A Boolean value indicating if the package is active. **Allowable Values:** true, false
  - `packageSummary` string, nullable: A detailed description of the background check package and what is included in the package. **Allowable Values:** 250 char max
  - `packageName` string, nullable: The name of the specific background check package that the users will see. **Allowable Values:** 250 char max
  - `services` ServiceDto[], nullable: An array of objects representing the underlying services that are included in the background check package.
    - `serviceName` string, nullable: The name of the specific service within a background check package that the users will see. **Allowable Values:** 150 char max
    - `serviceSummary` string, nullable: A detailed description of the underlying service in a package. **Allowable Values:** 250 char max
  - `price` PriceDto: An object representing the price of the package.
    - `value` number, double: The value amount, or cost, for the package.
    - `currency` string, nullable: The currency of the price. **Allowable Values:** USD, EUR, GBP, CAD
  - `billingCode` string, nullable: Billing code created by a client that can be associated with an order (optional). **Allowable Values:** 150 char max
  - `businessUnitId` string, nullable: (Optional) Business Unit ID for this package. On write this field is only honored in BU-only mode (package without a billing code); if the package has a billing code, the package's business unit is derived from that billing code and this field is ignored. On read it reflects the effective business unit (derived from the billing code when one is present). **Allowable Values:** 150 char max
  - `isInternational` boolean: Indicates whether it is international package.

## Response `200`

Returns the details of the upsert operation

- ScreeningPackageUpsertResponse: Screening Package Upserted 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)