FaceCard Docs
API reference

GET /v1/usage

Read monthly usage for your app.

GET /v1/usage?month=2026-10

Returns usage counts for one calendar month. Credential: secret key.

curl "https://api.facecard.dev/v1/usage?month=2026-10" \
  -H "Authorization: Bearer fc_sk_live_xxx"
{
  "month": "2026-10",
  "auths": 412,
  "limit": 1000,
  "enrolls": 37,
  "matches_ok": 351,
  "matches_failed": 24
}
FieldDescription
monthThe month, YYYY-MM.
authsEnroll and match calls that reached face matching, success or failure. This is the number your plan limit counts.
limitYour plan's auths per month.
enrollsEnrollments.
matches_okMatches that signed a user in.
matches_failedMatches that returned no_match.

Errors

StatusCodeWhen
400invalid_requestmonth is not in YYYY-MM form.
401unauthorizedMissing or invalid secret key.
429rate_limitedMore than 600 requests a minute for this key.

On this page