Screening Package
Delete 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
Deletes screening package
Use Cases
- Partner does not want this package to be displayed in the UI for the client
delete/compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages/{packageId}
Request
- Base URLdc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
- URLdc1demogwext.paylocity.com/compliance/v1/companies/{companyId}/backgroundCheck/screeningPackages/{packageId}
- AuthAPI key in header Authorization
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.
Headers
testModeboolean
If true all responses are mocked and generated randomly
Authorizationstring required
Authorization token. Ex. Bearer ...
Response
Returns the deatils of the delete operation
Changes
No recorded changes to this operation across all 1 revision of this API.