Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Screening Package

Upsert Screening Package

🚧 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
post/compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages/{packageId}

Path parameters

companyIdstring required

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

packageIdstring required

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

Headers

testModeboolean

If true all responses are mocked and generated randomly

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

isActiveboolean

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

packageSummarystring nullable

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

packageNamestring nullable

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

billingCodestring nullable

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

businessUnitIdstring nullable

(Optional) Business Unit ID to associate this package with a package businessUnit. Allowable Values: 150 char max

isInternationalboolean

Indicates whether it is international package.

Response

Returns the details of the upsert operation