Get Paystub/Employee Check Link
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Given the Company ID and Employee Check ID, Zeal returns an expirable, mobile-friendly link with the employee check details, including the ability to download the paystub. This link can be hosted on your custom domain in an iframe component and/or can be opened directly in an employee's browser.
NOTE: This link expires 24 hours after generation.
Returns
Returns response status and the link to the requested employee.
The following is an example of what a paystub would look like in the downloaded PDF format:
| attributes | type | description |
|---|---|---|
| success | boolean | Response status |
| data | string | Link to paystub |
| errors | array | Contains a list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |
companyID
string
required
Company ID of employer
employeeCheckID
string
required
ID of Employee Check
allow_retry
boolean
Defaults to false
Boolean flag to allow the worker to retry a returned transaction on this employee check
truefalse
``200 200
``400 400
Updated 3 months ago
ShellNodeRubyPHPPython
xxxxxxxxxx
curl --request GET \
--url 'https://api.zeal.com/paystubLink?allow_retry=false' \
--header 'accept: application/json'
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200 - Result400 - Result
Updated3 months ago