faceping.aifaceping.aidocs

Introduction

FacePing lets your guests skip the queue with face check-in — with their consent, verified against their own ticket, on an offline gate, and deleted after the event.

FacePing adds an optional face check-in lane to your events. Guests who opt in enrol once, usually right after buying their ticket; at the gate they show their ticket and look at the camera, and the gate confirms they're the ticket holder in about a second — even with no internet.

How it works#

  1. Create an event in the dashboard or with the API.
  2. Guests opt in. After checkout, your page shows the FacePing widget (or you send a guest link). The guest reads your notice, ticks the consent boxes themselves and takes a selfie. The photo is turned into a face template and discarded.
  3. Gates download the event. Each gate device gets a read-only, one-event device token and syncs an encrypted copy of that event's templates.
  4. At the door, the guest scans their ticket and looks at the camera. The gate checks that face against that ticket only (1:1), with liveness checks, and lets them through.
  5. After the event, face data is deleted automatically — 7 days after by default, or sooner if you choose — on the server and on every gate device.

Guests who don't opt in use your standard entrance. Every event must offer one; FacePing won't create an event without it.

Base URL and authentication#

All API calls go to your region:

Region Base URL
EU https://api-eu.faceping.ai

Authenticate with your API key in the X-Api-Key header. Create keys in Dashboard → API keys. Keys belong on your server: never put one in a browser, an app or a gate device — the widget and gates use their own short-lived, single-purpose tokens.

curl https://api-eu.faceping.ai/v1/events \
  -H "X-Api-Key: $FACEPING_API_KEY"

What you can build#

You want to… Use
Let buyers opt in on your ticket confirmation page The widget
Email or text a guest a link to opt in Guest links
Collect the photo and consent in your own app Server-side enrolment
Run the gates Gate devices and the SDK
Handle withdrawals and erasure requests Guests and deletion

Next: the Quickstart gets a guest enrolled in five minutes.