Scan tracking

Public scan endpoint — receives the in-person QR scan event and pings the review-request flow.

Public scan endpoint — receives the in-person QR scan event and pings the review-request flow.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
POSTPublic scan trackingPublic, unauthenticated endpoint hit when an end customer scans a QR code.