PATCH Candidate Background Screening Right to Work

Patch Candidate Background Screening Right to Work to Dayforce. Candidate work rights status is displayed on the candidate grid in the Indicators field.

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

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

Parameters

Object name, properties, type, and description for parameters

Parameters	Subparameters	Type	Description
ScreeningRequestId*	N/A	String	Dayforce candidate background screening reference ID
CandidateRightToWorkResults	See next table	N/A	The candidate right to work results. See next table for parameters.

CandidateRightToWorkResults Parameters

Object name, properties, type and description for parameters for CandidateRightToWorkResults

CandidateRightToWorkResults Parameters	Subparameters	Subparameters	Type	Description
CandidateRightToWorkResultId			Int	The candidate right to work result identifier
WorkRightStatus			String	The right to work status. One of: “UNLIMITED”, “LIMITED” or “NONE”
Status			String	The status of the process. For example, "Pending.
DateIssued			DateTime	The date the right to work request was issued
PartnerIdentifier			Int	The partner identifier for the candidate
DateCompleted			DateTime	The date the right to work process was completed
WorkRightEffectiveStart			DateTime	The effective start date of the right to work.
WorkRightEffectiveEnd			DateTime	The effective end date of the right to work.
RejectionOrCancellationReasons				The rejection or cancellation reasons
	ReasonCode		String	The reason code for rejection/cancellation
	ReasonDescription		String	The reason description for rejection/cancellation
Documents
	CandidateRTW DocumentId		Int	The unique identifier
	DocumentName		String	The document name
	DocumentExtension		String	The document extension
	DateAdded		DateTime	The date the document was added or uploaded
	DateExpire		DateTime	The expiry date of the document if any.
	Type		String	The type of document e.g. “PASSPORT”
	PathwayCode		String	The pathway code (not applicable for every provider)
	CountryCode		String	The country code
	Sources			The documents’ source
		SingleDocumentBase64	String	If the document is a single document, then the base64 is provided here.
		DocumentFrontBase64	String	If the document is a front-page document, then the base64 is provided here. For example, the front page of a passport.
		DocumentBackBase64	String	If the document is a back-page document, then the base64 is provided here. For example, the back page of a passport.
	Details			The document details
		Name	String	The name of the document detail. For example, "Passport Number".
		Value	String	The value of the document detail
	DocumentErrors			The document errors
		Code	String	The error code
		Message	String	The message of the document error

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

{
  "ScreeningRequestId": "2BED0FA964C747B4B69B4E42C646E254",
  "CandidateRightToWorkResults": {
  "WorkRightStatus": "UNLIMITED",
  "Status": "DONE",
  "DateIssued": "2023-04-28T13:22:58.740Z",
  "PartnerIdentifier": 12,
  "DateCompleted": "2023-04-28T13:22:58.740Z",
  "WorkRightEffectiveStart": "2023-04-28T13:22:58.740Z", 
  "WorkRightEffectiveEnd": null,
  "RejectionOrCancellationReasons": null,
  "Documents": [
    {
      "CandidateRTWDocumentId": 9,
      "DocumentName": "PASSPORT_FRONT",
      "DocumentExtension": "jpg",
      "DateAdded": "2023-03-15T13:22:58.740Z",
      "DateExpire": "2024-03-15T13:22:58.740Z",
      "Type": "PASSPORT",
      "PathwayCode": "PASSPORT_UK_CITIZEN",
      "CountryCode": "CAN",
      "Sources": {   
        "SingleDocumentBase64": "",
        "DocumentFrontBase64": "INSERT_BASE64_HERE",
        "DocumentBackBase64": ""
        },
      "Details": [
        {
          "Name": "Passport Number",
          "Value": "223321234"
        },
        {
          "Name": "Other",
          "Value": "example"
        }
      ],
      "DocumentErrors": null
    },
    {
      "CandidateRTWDocumentId": 10, 
      "DocumentName": "PASSPORT_BACK",
      "DocumentExtension": "jpg",
      "DateAdded": "2023-03-15T13:22:58.740Z",
      "DateExpire": "2024-03-15T13:22:58.740Z",
      "Type": "PASSPORT",
      "PathwayCode": "PASSPORT_UK_CITIZEN",
      "CountryCode": "CAN",
      "Sources": {
         "SingleDocumentBase64": "",
         "DocumentFrontBase64": "",
         "DocumentBackBase64": "INSERT_BASE64_HERE"
         },
      "Details": [
        {
        "Name": "SSN",
        "Value": "223321234"
        },
        {
        "Name": "TRV",
        "Value": "example"
        }
      ],
      "DocumentErrors": null
    }
    ]
  }
}