Paycard Onboarding Status Event (Early Access)

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 worker (if the worker is of type Employee)
contractorID	string	Zeal `contractorID` of worker (if the worker is of type Contractor)
first_name	string	First name of Worker
last_name	string	Last name of Worker
business_name	string	Business Name
status	string	Holds one of the following values: `requested` `declined` `provisioned`
timestamp	datetime

Returns

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

Raw Content Example

requesteddeclinedprovisioned

{
  "test": true,
  "companyID": "1234ae8a477346e6900741c5301f1cc8",
  "employeeID": "123ebd7dba526b6b852048f5",
  "first_name": "Erlich",
  "last_name": "Bachman",
  "business_name": "Test Company",
  "status": "requested",
  "timestamp": "2024-01-21T21:29:42Z"
}

{
  "test": true,
  "companyID": "1234ae8a477346e6900741c5301f1cc8",
  "employeeID": "123ebd7dba526b6b852048f5",
  "first_name": "Erlich",
  "last_name": "Bachman",
  "business_name": "Test Company",
  "status": "declined",
  "timestamp": "2024-01-21T21:29:42Z"
}

{
  "test": true,
  "companyID": "1234ae8a477346e6900741c5301f1cc8",
  "employeeID": "123ebd7dba526b6b852048f5",
  "first_name": "Erlich",
  "last_name": "Bachman",
  "business_name": "Test Company",
  "status": "provisioned",
  "timestamp": "2024-01-21T21:29:42Z"
}

Updated 5 months ago