PATCH Candidate Background Screening

Dayforce RESTful Web Services Developer Guide

Version
R2025.2.1
PATCH Candidate Background Screening

Patch Candidate Background Screening to Dayforce. Candidate Background Screening enables the provider to update the background screening status, URL, Report containing Personal Identifiable Information (PII) to Dayforce.

The URL for PATCH Candidate Background Screening uses the following base URL:

https://www.dayforcehcm.com/api/CompanyName/V1/BackgroundScreening

Parameters

Object name, properties, type, and description for parameters
Parameters Object Name Object Properties Type Description
ScreeningRequestId* N/A N/A String Dayforce candidate background screening reference
URL N/A N/A String Partner background screening link to access candidate result or link towards Partner site.
ScreeningStatus Screening Status object Status String Candidate background screening status
AdjudicationStatus String Candidate background screening adjudication status
CandidatePII Candidate PII object DateOfBirth String Candidate date of birth
SocialSecurityNumber String Candidate Social Security number
SocialInsuranceNumber String Candidate Social Insurance number
DriverLicense String Candidate driver license

Below is a sample response that Dayforce is expecting from the provider:

{
  "ScreeningRequestId": "398741C26EF646E58C85AF9033BC7960",
  "Url": "http://www.example.com/?id=1bf0969a-3f08-499d-b64f-c6a0348baa32",
  "ScreeningStatus": {
    "Status": "Complete",
    "AdjudicationStatus": "Done"
  },
  "CandidatePII": {
    "DateOfBirth": "1990-04-20",
    "SocialSecurityNumber": "351762213",
    "SocialInsuranceNumber": "111111",
    "DriverLicense": "RV046216"
  }
}