---
title: "Check a PIN"
method: POST
path: "/v1/locations/{locationId}/staff/pin-check"
tags: ["Staff"]
---

# Check a PIN

`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

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.

## Path parameters

- `locationId` string, required

## Request body

- PinCheck: A PIN typed by a person at your screen.
  - `pin` string, required: The PIN, digits only.

## Response `200`

OK

- PinCheckResult: Whose PIN it is.
  - `name` string: The person's name. Left out when none is registered.
  - `staffId` string, required: Staff id.

## Other responses

- `default`: Any failure. See the Errors section.

---

[API](https://skmtc.dev/cliento/apis/cliento-api.md) · [All operations](https://skmtc.dev/cliento/apis/cliento-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cliento/apis/cliento-api/revisions/29ca811bc061?raw)