v1
latestOpenAPI 3.0.42026-07-2481154567.6 KBScreening Package
Get Screening Packages
🚧 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
Returns the screening packages for the companyId
Use Cases
- Partner needs to confirm that package information with Paylocity is correct and calls for the package information for a specific company ID
get/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 ...
Response
Returns the screening packages