Staff

Check a PIN

Says whose PIN was typed, so your own screen can let staff identify themselves with the PIN they already use at the point of sale. A PIN belongs to one person at a location. Nothing is signed in and no token is issued: send the staff id on the calls that take one. A PIN nobody has is refused with pin_not_recognised. An Idempotency-Key is ignored here.

post/v1/locations/{locationId}/staff/pin-check

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/staff/pin-check
  • Auth: HTTP bearer

Path parameters

locationIdstring required

Request body

pinstring required

The PIN, digits only.

Example request

{
  "pin": "4711"
}

Response

OK

namestring

The person's name. Left out when none is registered.

staffIdstring required

Staff id.

Example response

{
  "name": "Clara Nyberg",
  "staffId": "stf_7Qm2xLd9Kc4Vb1Ts8HpWzE"
}

Changes

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