Retrieve monthly usage | CONFIRM Docs

Returns the partner-level rollup and per-organization breakdown for a calendar month — candidates ingested, screenings initiated and completed, and background checks ordered. Intended for wholesale billing reconciliation.

Authentication

AuthorizationBearer

Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Partner API key sent as `Authorization: Bearer cfk_...`. Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Query parameters

monthstringRequiredformat: "^\d{4}-(0[1-9]|1[0-2])$"

Calendar month in YYYY-MM format.

Response

Usage report for the month.

monthstringOptional

YYYY-MM.

totalsobjectOptional

organizationslist of objectsOptional

Per-organization breakdown.

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

1	{
2	"month": "2026-06",
3	"totals": {
4	"candidates_ingested": 412,
5	"screenings_initiated": 398,
6	"screenings_completed": 301,
7	"background_checks_ordered": 87
8	},
9	"organizations": [
10	{
11	"org_id": "org_4Nv8sJqKfH",
12	"candidates_ingested": 412,
13	"screenings_initiated": 398,
14	"screenings_completed": 301,
15	"background_checks_ordered": 87
16	}
17	]
18	}

$	curl -G https://api.confirm.global/partner/v1/usage \
>	-H "Authorization: Bearer <token>" \
>	-d month=2026-06