Upsert Screening Package

post

https://dc1demogwext.paylocity.com/compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages/{packageId}

🚧
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 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 Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

packageId

string

required

The Id of the Screening Package.
Allowable Values:
36 char max

Body Params

The Package data

Screening package Upsert Request.

isActive

boolean

A Boolean value indicating if the package is active.
Allowable Values:
true, false

packageSummary

string | null

A detailed description of the background check package and what is included in the package.
Allowable Values:
250 char max

packageName

string | null

The name of the specific background check package that the users will see.
Allowable Values:
250 char max

services

array of objects | null

An array of objects representing the underlying services that are included in the background check package.

services

price

object

An object representing the price of the package.

billingCode

string | null

Billing code created by a client that can be associated with an order (optional).
Allowable Values:
150 char max

businessUnitId

string | null

(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.

Headers

testMode

boolean

If true all responses are mocked and generated randomly

Responses

400

Bad Request Error - Returns the details of the error

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200Returns the details of the upsert operation

415Unsupported Media Type - Returns the details of the error