Get Paystub Link

Fetches an expirable link that displays an employee paystub.

get/paystubLink

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/paystubLink/get.ts
A function with typed inputs. Its response is checked against the schema.

companyIDstring required

Company ID of employer

employeeCheckIDstring required

ID of Employee Check

allow_retryboolean

Boolean flag to allow the worker to retry a returned transaction on this employee check

200

successboolean

datastring

{
  "success": true,
  "data": "https://payroll.yourdomain.com/public/paystub/<accessToken>"
}

No recorded changes to this operation across all 1 revision of this API.