REST Services for Updating an Employee's I-9 Order Status

To make changes to an employee’s I-9 order status, an HTTP request can be made to Dayforce’s web services using the HTTP verb PATCH.

The base URL for the Employees API is as follows, replacing <clientName> with your organization’s name:

https://www.dayforcehcm.com/api/<clientName>/v1/I9Orders

Overview

To make changes to an employee's I-9 order status, an HTTP request can be made to Dayforce's web services using the HTTP verb PATCH.

The base URL for the I9Orders API is as follows, replacing <clientname> with your organization's name:

https://www.dayforcehcm.com/api/<ClientName>/V1/I9Orders

Parameters

Consumers can update a single employee’s I-9 order using the following parameters:

Request Body

The request body is defined with the following properties:

• I9OrderId (string): The id of the order to be updated.
• OrderStatusXRefCode: An XRefCode corresponding to an I-9 order status that Dayforce supports. The following values are supported:
  • SENT TO EMPLOYEE
  • PENDING EMPLOYER
  • COMPLETED
  • NEW
  • DECLINED BY EMPLOYEE
  • PENDING EMPLOYEE

i9OrderId (string)

• This parameter should be specified both as query parameter and as a parameter in the request body. The query parameter and parameter in the request body need to match.
• The id of the order to be updated.
• The URL syntax is the following: https://www.dayforcehcm.com/api/CompanyName/V1/I9Orders/exampleI9OrderId

IsValidateOnly (boolean)

• Used to specify that all of the validations need to be performed without committing any changes
• Use this parameter to control whether committing information to your instance of Dayforce is your responsibility.
• The URL syntax is the following: https://www.daforcehcm.com/api/CompanyName/V1/I9Orders/exampleI9OrderId?isValidateOnly=true

Response

This call returns an HTTP 200 response code with an empty response body when the call is successful.

If the call isn’t successful, then the standard error response is returned. For example:

{
    "requestId": "800000d9-0006-f800-b63f-84710c7967bb",
    "processResults": [
        {
            "code": "I9_NO_ORDER_FOUND",
            "level": "ERROR",
            "message": "No I-9 order was found that matches the I-9 order id of 'asfd'. isValidateOnly = False."
        }
    ]
}