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
}| Field | Description |
|---|---|
month | The month, YYYY-MM. |
auths | Enroll and match calls that reached face matching, success or failure. This is the number your plan limit counts. |
limit | Your plan's auths per month. |
enrolls | Enrollments. |
matches_ok | Matches that signed a user in. |
matches_failed | Matches that returned no_match. |
Errors
| Status | Code | When |
|---|---|---|
| 400 | invalid_request | month is not in YYYY-MM form. |
| 401 | unauthorized | Missing or invalid secret key. |
| 429 | rate_limited | More than 600 requests a minute for this key. |