Get I9 Status (Early Access)

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

This request uses the companyID and employeeID attributes to return key information about the I9 form status.

Returns Skip link to 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 message
code: Error code as described in Error codes

Possible Status Values Skip link to 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
STARTED
SECTION_1_COMPLETED
AUTHORIZED_REPRESENTATIVE_CONTACTED
SECTION_2_COMPLETED

Possible Admin Review Status Values Skip link to 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.

companyID

string

required

Company ID of employer

employeeID

string

required

Employee ID of the employee

``200 200

``400 400

Updated about 1 year ago

ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request GET \
 \
     --url https://api.zeal.com/employees/getI9Status \
 \
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updated about 1 year ago