---
title: "Get Webhook for Candidate Screening Order"
method: GET
path: "/compliance/v1/companies/b6001/backgroundCheck/candidateScreeningOrders/subscription"
tags: ["Subscription"]
---

# Get Webhook for Candidate Screening Order

`GET /compliance/v1/companies/b6001/backgroundCheck/candidateScreeningOrders/subscription`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/compliance/v1/companies/b6001/backgroundCheck/candidateScreeningOrders/subscription`
- Auth: API key in header `Authorization`

> 🚧 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](https://www.paylocity.com/contact/partner-form/) if you would like to discuss partnership opportunities.

**Summary Description**

Returns the webhook for the subscription of a new candidate screening order

## Headers

- `testMode` boolean
- `Authorization` string, required

## Response `200`

Returns the subscription callback details

- CandidateScreeningOrdersSubscriptionResponse: Callback informations.
  - `webhookCallbackId` string, uuid: The GUID of the Callback URL.
  - `apiKey` string, nullable: The API Key you specfied when you created the Callback URL.
  - `callbackDetails` CallbackDetailsDto: Callback Details
    - `successCallbackUrl` string, nullable: Your callback POST endpoint URL where you will receive new screening orders. Required. **Allowable Values:** 256 char max
    - `errorCallbackUrl` string, nullable: Your callback POST endpoint where you will receive errors occurred during the POST a new screening order. Required. **Allowable Values:** 256 char max
  - `callerDetails` CallerDetailsDto
    - `callerName` string, nullable: This is a field used to identify the partner, this typically is the company name. **Allowable Values:** 50 char max

## Other responses

- `400`: Bad Request Error - Returns the details of the error
- `401`: Unauthorized
- `404`: Returns the details of the error
- `415`: Unsupported Media Type - Returns the details of the error

---

[API](https://skmtc.dev/paylocity/apis/background-check-api.md) - [All operations](https://skmtc.dev/paylocity/apis/background-check-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/background-check-api/revisions/8d585de5e05e?raw)