Employee I9 Completion Event (Early Access)

This endpoint specifies what will be sent to your Employee I9 Completion Event Webhook. Zeal POSTs a request containing an Employee's I9 when they have been completed in the dashboard. You can update and test the webhook URL you want Zeal to hit on the 'API' Page of the Zeal Dashboard.

Request Body

attribute	type	description
test	boolean	Whether the Event was created/updated/deleted in Test Mode
companyID	string	Zeal `companyID` of Employer
employeeID	string	Zeal `employeeID` of Employee
first_name	string	First name of Employee
last_name	string	Last name of Employee
authorized_representative	object	Information on the Authorized Representative who reviewed the employee's I9 Show authorized_representative fields first_name - First name of authorized representative last_name - Last name of authorized representative email - Email of authorized representative decision - Decision of authorized representative. Possible values: `IN_PROGRESS` `APPROVED` `CHANGES_REQUESTED` decision_made_on - Date and time the decision was made on
documents	list	Document or documents provided by employee. Can contain multiple. Show documents values `CANADIAN_DRIVERS_LICENSE` `DAY_CARE_RECORD` `DRIVERS_LICENSE` `DS_1350` `EMPLOYMENT_AUTHORIZATION_DOCUMENT` `FOREIGN_PASSPORT` `FOREIGN_PASSPORT_WITH_FORM_I94` `FOREIGN_PASSPORT_WITH_I551_STAMP` `FORM_I179` `FORM_I197` `FORM_I551` `FORM_I766` `FORM_I94` `FORM_I94_RECEIPT` `FS_240` `FS_545` `FSM_OR_RMI_PASSPORT_WITH_FORM_I94` `GOVERNMENT_ID_CARD` `HOSPITAL_RECORD` `MILITARY_DEPENDENT_ID_CARD` `NATIVE_AMERICAN_TRIBAL_DOCUMENT` `SCHOOL_ID_CARD` `SCHOOL_RECORD` `SOCIAL_SECURITY_CARD` `US_BIRTH_CERTIFICATE` `US_COAST_GUARD_CARD` `US_MILITARY_CARD` `US_PASSPORT` `VOTER_REGISTRATION_CARD`
business_name	string	Business name

Returns

Doesn't return anything but rather POSTs a request with the I9 completion update to your webhook URL.

Raw Content Example

{
  "test": false,
  "companyID": "1eeec343485723ee58ufefhz",
  "employeeID": "cc4482374ee49487ruzieun",
  "first_name": "Erlich",
  "last_name": "Bachman",
  "authorized_representative": {
    "first_name": "Richard",
    "last_name": "Hendricks",
    "email": "[email protected]",
    "decision": "APPROVED",
    "decision_made_on": "2023-05-01T20:46:27.961Z"
  },
  "documents": [
    "US_PASSPORT"
  ],
  "business_name": "Test Company"
}