Update Screening Order Status

patch

https://dc1demogwext.paylocity.com/compliance/v1/companies/{companyId}/backgroundCheck/candidateScreeningOrders/status

🚧
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

This endpoint updates the Screening Order status for the given companyId and candidateScreeningOrderId. The patch operation on the candidate status endpoint allows you to update the status of the overall screening order and the related services. You can also send the URL where the recruiter can view the complete screening result. Using this endpoint, partners will be able to add new services to orders that have already been placed.

Use Cases

Partner sends the initial status of the order and services, i.e. Ordered and Pending
Partner needs to update the status of an order or services of an order
Partner is updating the order with new statuses and wants to add on additional services that were added to the order after it was placed

Path Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

Body Params

The data of the update

The update information for the screening order

candidateScreeningOrderId

uuid

Unique identifier of the screening order that was sent to you.

updatedAt

date-time

The date time of the update.Example: 2023-01-04T04:23:11.586Z

oldStatus

string | null

enum

The previous status of the screening order.

newStatus

string | null

enum

The new status of the screening order.

note

string | null

This is an optional field if a partner needs to send additional details with an order status.
Allowable Values:
250 char max

services

array of objects | null

The array of services in scope of which the screening order will be processed.

services

screeningReportDocuments

array of strings | null

An array of strings representing the URL of the screening report that can be viewed on the partner’s web application.

screeningReportDocuments

Responses

400

Bad Request Error - Returns the details of the error

401

Unauthorized

200Returns screening order id and status that were updated

415Unsupported Media Type - Returns the details of the error