get https://api.zeal.com/employees/getI9Status
Get the status of an I9's completion
This request uses the companyID and employeeID attributes to return key information about the I9 form status.
Returns
attribute | type | description |
---|---|---|
success | boolean | Response status |
data | object | Object with companyID, employeeID, I9 status, I9 timestamp, Admin Review status, Admin timestamp |
errors | array | Contains a list of error objects which consists of:message : Error messagecode : Error code as described in Error codes |
Possible Status Values
Status returns the status of the employee's I9 form.
attribute | type | description |
---|---|---|
status | string | Holds one of the following values:NOT_STARTED SECTION_1_COMPLETED AUTHORIZED_REPRESENTATIVE_CONTACTED SECTION_2_COMPLETED |
Possible Admin Review Status Values
Admin Review Status returns the status of an admin's review of the I9 form.
attribute | type | description |
---|---|---|
admin_review_status | string | Holds one of the following values:PENDING_REVIEW CHANGES_REQUESTED APPROVED NOTE: You must have the admin review feature enabled for your company for this field to appear and will generate after the authorized_representative approves the I9 form request. |