v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Preview Payroll by Check IDs

post/preview/checks

Request body

companyIDstring required

The ID of the Company

checksstring[] required

The ID of the Employee Check. This endpoint can accept an array of employeeCheckIDs

Response

200

statusinteger

successboolean

Example response

{
  "status": 200,
  "success": true,
  "data": {
    "job_id": "232c21f1-cc24-4664-8420-393d0acd21351",
    "status": "pending",
    "request_body": {
      "companyID": "h0c56cc41q1040ac8a3322342a3bbb462",
      "checks": [
        "c614c5ff59d7cc22eae4c9442f315"
      ],
      "job_type": "preview-checks",
      "has_live_key": true
    },
    "created_at": "2023-05-04T19:29:39.134Z"
  }
}