Loading Guardian Developer...



Please Wait...

I-9 Status Update

The integrated I-9 workflow includes status updates that detail steps in the I-9 process. External applications may not receive a status update for each step of the I-9 process depending on the speed with which the process is completed. Status updates are sent either as PATCH or POST requests to the defined API endpoint, depending on compatibility of the external application. The employee is identified by integrationCandidateId which is included in the request URL or the payload. The information in the payload allows users to take action and make decisions from within the external application. Next step details provide context as to who must take action and by when. The included URL allows authorized individuals to quickly jump to the relevant webpage within the Guardian interface. These requests utilize the http basic authentication method.

The integrated I-9 workflow includes status updates that follow the steps in the I-9 process. These status updates are sent as PATCH requests to the partner-defined API endpoint. The information in the payload allows users to take action and make decisions from within the partner’s interface. Next step details provide context as to who must take action and by when. The included URL allows authorized individuals to quickly jump to the relevant webpage within the Guardian interface. Patch requests utilize the http basic authentication method.

Method

PATCH or POST

 

Parameters

Parameter Description Type
i9Status The current state of the I-9 workflow string
i9NextStep The next action within the I-9 workflow string
i9NextStepDueDate The date the next action must be completed date
i9Url Link that takes the authorized user to the applicable employee page within Guardian string

 

I-9 Status

The following tables list the payload of the status requests. Column headers denote the parameters while the row values represent the various payload description. Requests will always return only one status update. The information in the I-9 URL column represent the landing pages associated to the URL destination.

The table lists of all I-9 statuses and the next step for each status. Each status Includes the next step due date if relevant, URL link endpoint, and special notes. Not all/every status update related to the I-9 process may be sent from Guardian due to the speed with which the process is completed.

I-9 Status
(i9Status)
Next Step
(i9NextStep)
Next Step Due Date
(i9NextStepDueDate)
I-9 URL
(i9Url)
Note
Section 1 Incomplete Sign Section 1 (Employee) Employee start date Section 1 Page I-9 Due Date based on company setting
Section 1 Completed Sign Section 2 (Verifier) Employee start date or start date + 3 company work days Section 2 Page I-9 Due Date based on company setting
Section 2 Completed Mark I-9 Completed Start date + 3 company work days I-9 Details Page I-9 Due Date based on company setting
I-9 Completed Approve I-9 Form Start date + 3 company work days I-9 Details Page I-9 Due Date based on company setting
I-9 Approved No Further Action Required Start date + 3 company work days E-Verify Page Next Step based on location setting
Receipt Replacement Pending Update Receipt Replacement Document Start date + 90 days I-9 Details Page
Re-verification Pending Document Updated Work Authorization I-9 document expiration date I-9 Details Page
Section 3 Incomplete Sign Section 3 Section 3 creation date I-9 Details Page
Section 3 Completed Approve Section 3 Section 3 creation date I-9 Details Page

 

Example

I-9 Status Request


        {
            "i9Status": "I-9 Completed",
            "i9NextStep": "Approve I-9 Form",
            "i9NextStepDueDate": "2015-01-04",
            "i9Url": "https://<server>/4DCGI/WEB_Login_URL/123/I9Mod/123456/"
        }