Live and test credits
Your organisation has two separate wallets at the same prices: live and test. The mode of your API key decides which one you see. A test key reads the test credits and a live key reads the live credits, never the other’s. If a wallet was never set up (for example, test credits),wallet_configured is false and a campaign in that mode is refused until Record adds credits.
What a candidate costs
Each verification method on a job has its own price per candidate:
A campaign whose job uses both is charged for each. A price of
null means none is set for your organisation, and a campaign that needs that method is refused.
Endpoints
Get your credits
GET /credits
Scope: credits:read
wallet.balance is what a campaign can spend now. wallet is null when wallet_configured is false, and billing_configured is false when your organisation has no billing account at all.
List credit usage
GET /credits/usage
Scope: credits:read
- Newest entries come first.
creditsis negative when credits were used and positive when they were given back (typeis thenrefund,reversaloradjustment). totals.credits_usedcovers everything that matches your filters, not just this page, net of anything given back.- Only blue-collar entries of your organisation and your key’s mode are listed.
Errors
Both calls also return the common errors.

