POSTs request when an I9 form has been completed.
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 |
employeeID | string | Zeal |
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
|
documents | list | Document or documents provided by employee. Can contain multiple.
|
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"
}