v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Screening Package

Upsert Screening Packages [Batch]

🚧 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

Bulk Upsert information about screening packages

Use Cases

  • Partner wants to send over multiple screening packages for a client, can be when onboarding a new client, or can be when client adds new packages to their company
  • Partner wants to make bulk changes to screening packages to make them either active or inactive for a client
  • Partner wants to update the prices of a client’s screening packages
  • Partner wants to bulk add services to a packages
  • Partner wants to add a billing code to correlate to a specific BGC package
post/compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages

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

Headers

testModeboolean

If true all responses are mocked and generated randomly

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

Response

Returns the deatils of the Bulk upsert