Required*
| Parameters | Type | Description |
|---|---|---|
| ScreeningRequestId | Dayforce candidate background screening reference | |
| id* | Provider candidate background screening reference | |
| Link | Candidate Background screening URL link | |
| Errors | List of Errors (if Any) | |
| Code | Status of the request | |
| Message | Status of the request |
Below is a sample response that Dayforce is expecting back from the provider after the POST call. Note that Id is the background screening provider’s unique identifier of the screening request order.
{
"ScreeningRequestId”: "F7145A1047FD44C1A0CBADEF89C99C22",
"Id": "123",
"Link": "http://sample-background-screening-url.com"
}
Below is a sample request that Dayforce send to Provider:
{
"ScreeningReferenceId": "F7145A1047FD44C1A0CBADEF89C99C22",
"ScreeningRequestedDate": "2020-09-01T11:27:41.216Z",
"OrderDetails": {
"PackageId": "Package1",
"BillingCode": "BillCode1",
"RecruiterEmail": "Recruiter@email.com"
"HiringManagerEmail": "HiringManager@email.com"
"SubmitterEmail": "Submitter@email.com"
},
"CandidatePersonal": {
"CandidateId": 10001,
"FirstName": "CandidateFirstName",
"LastName": " CandidateLastName ",
"ConfirmedNoMiddleName": true,
"PreferredGivenName": "CandidatePreferreGivenName",
"Email": "Candidate@email.com",
"Phone": "123456789",
"PostalAddress": {
"Address1": "Address1",
"Address2": "Address2",
"Address3": "Address3",
"City": "City",
"PostalCode": "123456"
}
},
"CandidateProfile": {
"EducationHistory": [
{
"EducationHistoryId": 20001,
"SchoolName": "CandidateSchoolName",
"StartDate": "2020-01-01",
"EndDate": "2020-07-01",
"Degree": {
"DegreeName": "Bachelor's",
"Major": "Accounting",
"DegreeCompleted": true
},
"SchoolLocation": {
"City": "CandidateSchoolCity",
"State": " CandidateSchoolState",
"Country": " CandidateSchoolCountry"
}
}
],
"EmploymentHistory": [
{
"EmploymentHistoryId": 20002,
"EmployerName": "CandidateEmployerName",
"CurrentEmployer": false,
"Department": "CandidateDepartment",
"JobTitle": "CandidateJobTitle",
"StartDate": "2020-01-01",
"EndDate": "2020-07-01",
"Salary": "15000.00000",
"Location": {
"City": "CandidateEmployerCity",
"Country": "CandidateEmploymentCountry"
}
}
],
"References": [
{
"ReferenceId": 20003,
"FirstName": "CandidateReferenceFirstName",
"LastName": " CandidateReferenceLastName",
"ReferenceEmail": "reference@email.com",
"BusinessPhone": "1234567899",
"MobilePhone": "9854245256"
}
]
},
"JobRequisition": {
"JobRequisitionId": 30001,
"JobRequisitionTitle": "JobRequisitionTilte",
"JobLocation": "JobLocation",
"DepartmentName": "DepartmentName",
"HiringManager": "HiringManagerFirstName HiringManagerLastName",
"Recruiter": "RecruiterFirstName RecruiterLastName"
}
}