v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get Paystub Link

Fetches an expirable link that displays an employee paystub.

get/paystubLink

Query parameters

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

Response

200

successboolean
datastring

Example response

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