v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB

Subscription

Get Webhook for Candidate Screening Order

🚧 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 webhook for the subscription of a new candidate screening order

get/compliance/v1/companies/b6001/backgroundCheck/candidateScreeningOrders/subscription

Headers

testModeboolean

If true all responses are mocked and generated randomly

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Returns the subscription callback details

webhookCallbackIdstring uuid

The GUID of the Callback URL.

apiKeystring nullable

The API Key you specfied when you created the Callback URL.