Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Candidate Screening Order

Get Screening Orders for Partner

🚧 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

Partners can use this endpoint to retrieve background check (BGC) orders using flexible filters. It supports pulling orders across partner-linked companies, or narrowing by companyID, orderID, candidateID, or date range. Results are always sorted by companyID.

Use Case 1: Partner-wide Order Retrieval

A partner wants a consolidated feed of all BGC orders across every company tied to their API client ID for monitoring and reporting.

Use Case 2: Candidate-Specific Lookup

A partner needs to review all background check orders tied to a single candidate, filtered by their Paylocity candidateID.

get/compliance/v1/companies/b6001/partner/backgroundCheckOrders

Query parameters

filterstring

filter like: companyId eq '1235'. Filterable fields: companyId, candidateScreeningOrderId, candidate/firstName, candidate/middleName, candidate/lastName

includeTotalCountboolean

If true it will add X-Pcty-Total-Count header with total count for this specific query.

offsetinteger

Pagination offset.

limitinteger

Pagination limit.

Headers

testModeboolean

Test mode. If enabled, mocked data are returned.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Returns list of the screening order

candidateScreeningOrderIdstring uuid

Unique identifier for the candidate screening order.

companyIdstring nullable

Identifier for the company associated with the screening.

packageIdstring nullable

Identifier for the screening package selected.

billingCodestring nullable

Billing code associated with the screening order.

locationstring nullable

Location associated with the screening order.

workAddressstring nullable

WorkAddress associated with the screening order.

workCitystring nullable

WorkCity associated with the screening order.

workCountrystring nullable

WorkCountry associated with the screening order.

workProvincestring nullable

WorkProvince associated with the screening order.

businessUnitIdstring nullable

Business Unit ID associated with the screening order. Optional.

status'Ordered' | 'WaitingOnCandidate' | 'InProgress' | 'Hold' | 'Complete' | 'CompleteWithCancelled' | 'Cancelled' | 'CompleteNeedsReview' | 'CompleteNotEligible' | 'Suspended' | 'Resumed' | 'CompleteDisputed' | 'InvitationExpired' | 'InvitationCancelled' | 'PreAdverseActionSent' | 'AdverseActionCancelled' | 'Dispute' | 'AdverseActionSent'

Screening order status.

createdAtstring date-time

Date of when the screening order was created.

updatedAtstring date-time

Date of when the screening order was updated.

notestring nullable

This is an optional field that can contain additional details.