Paperwork Submission Object

The Paperwork Submission object represents a submitted paperwork form for a worker's onboarding process.

attribute	type	description
templateID	string	Unique identifier for the template used for this submission
submissionID	string	Unique identifier for the submission
submission_date	string	Date and time when the paperwork was submitted (format: ISO 8601)
worker_type	string	Type of worker. Can be `employee` or `contractor`
companyID	string	Unique identifier for Zeal company
employeeID	string	Unique identifier for the employee (if worker_type is 'employee')
contractorID	string	Unique identifier for the contractor (if worker_type is 'contractor')
fields	object	Key-value pairs of submitted form fields
jurisdiction	string	Abbreviation of jurisdiction
paperwork_type	string	Type of paperwork form submitted (W4 or I9)
url	string	URL to access the submitted paperwork

Example Paperwork Submission Object

{
  "templateID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "submissionID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "submission_date": "2023-06-01T12:00:00Z",
  "worker_type": "employee",
  "companyID": "603d0f8f1c4b2a4e28c8f0b4",
  "employeeID": "603d0f8f1c4b2a4e28c8f0b4",
  "contractorID": null,
  "jurisdiction": "VA",
  "fields": {
    "field1": "value1",
    "field2": "value2"
  },
  "paperwork_type": "W4",
  "url": "https://example.com/submission/12345"
}