Page Comparison

...

POST /loyalty/v2/identify

Headers

We will use the same headers as the Partner API.

Authentication and authorization will use the bearer Bearer token in JWT format , which includes the API key, and identifies the following, based on this documentation: as specified in /wiki/spaces/IN/pages/3739288100

...

Brand (e.g. BK)

...

Region (e.g. UK)

...

Sub, which is the integration partner (e.g. NCR, Khumbu)

...

.

Body

• identifier <string>: OTP (6 digit code) or Loyalty ID in UUID format.

• location: object identifying the location the guest is identifying from.

  • storeId <integer>: uniquely identifies the store where the guest is identifying from.

  • terminalId <string> (optional): identifies the POS or Kiosk terminal used in the restaurant

  • hasLoyalty <boolean> (optional): defaults to true. If false, then no points will be earned or burned for transaction and no rewards can be ordered.

• content <boolean> (optional): whether the endpoint should return the list of offers and rewards that are visible to this guest. Defaults to false.

...

• HTTP 400 (Bad Request) if the request body has an incorrect format. In this case, the response will include details about which specific field or fields have an incorrect format.

• HTTP 401 (Unauthorized) if the bearer token is missing or not valid.

• HTTP 403 (Forbidden): if the specified identifier is not valid.

• HTTP 404 (Not Found): if the specified storeId was not found.