Verify Kiosk PIN

Verifies the employee's kiosk PIN. Returns error code 400 if the PIN is incorrect.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/kiosk/{kioskId}/checkpin

Path parameters

Parameter name Value Description Additional
businessId string Required
kioskId string Required

Request body

The request body takes a complete CheckKioskPinModel resource, containing the following writable properties:

{
    "employeeId": "int32",
    "pin": "string"
}

Properties

Name Type Description
employeeId int32 Nullable
pin string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 KioskEmployeeModel