API Reference

Update Employee Check

patch
https://api.zeal.com/employeeCheck

Update a pending employee check.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Edit Employee Check information. The Employee Check object MUST still be in the pending status.

Returns

attributestypedescription
successbooleanResponse status
dataobjectEmployee Check with the given EmployeeCheckID
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

Company ID of the employer

string
required

ID of Employee Check

string

Reporting Period ID of Employee Check

date

Date of Employee Check

boolean

Whether manual approval is required for this Employee Check.

boolean

Set this field to true in order to approve this Employee Check

disbursement
object

Set the disbursement method of check - Zeal supports Direct Deposit, Download Check, Physical Check, Prepaid, and Paycard (Early Access) disbursement methods

Responses

Updated 11 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago