Paperwork Submission Object

Paperwork Submission Object

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

attributetypedescription
templateIDstringUnique identifier for the template used for this submission
submissionIDstringUnique identifier for the submission
submission_datestringDate and time when the paperwork was submitted (format: ISO 8601)
worker_typestringType of worker. Can be employee or contractor
companyIDstringUnique identifier for Zeal company
employeeIDstringUnique identifier for the employee (if worker_type is 'employee')
contractorIDstringUnique identifier for the contractor (if worker_type is 'contractor')
fieldsobjectKey-value pairs of submitted form fields
paperwork_typestringType of paperwork form submitted
urlstringURL 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": "603d0f8f1c4b2a4e28c8f0b5",
  "fields": {
    "field1": "value1",
    "field2": "value2"
  },
  "paperwork_type": "type1",
  "url": "https://example.com/submission/12345"
}