API Reference

Create a paperwork submission

put
https://api.zeal.com/paperwork/submissions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Create a Paperwork Submissions(s). This endpoint will return the created Paperwork Submission Object of Paperwork Submission object(s).

Returns

attributetypedescription
successbooleanResponse status
dataobjectObject of Paperwork Submission object(s).
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

Unique identifier for the paperwork template.

string
enum
required

Type of worker (Employee or Contractor).

Allowed:
string
required

Unique identifier for the company.

string | null

Unique identifier for the employee. Nullable if the worker type is contractor.

string | null

Unique identifier for the contractor. Nullable if the worker type is employee.

fields
object
required

Additional fields for the paperwork submission.

Responses

Updated 11 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?