Skip to main content
Each candidate you add to an enrichment campaign costs credits. These two calls only read your credits: they never change a balance. They need the enrichment:credits scope, which is separate from the other enrichment scopes, so a key that reads results cannot see your balance.

Which wallet you see

The key’s mode picks the wallet. A VFN_TEST_ key sees the test wallet and a VFN_LIVE_ key the live one. Both are priced the same.

Check what you have

GET /enrichment-credits returns the wallet, the price of one candidate and how many more candidates the balance covers.
Read it before you start a campaign. A campaign that costs more than the balance is refused with 402 INSUFFICIENT_CREDITS and nothing is created: the whole batch is checked first.
Missing data is a normal answer, not an error. With no billing account you get 200 with billing_configured: false. A test wallet that was never set up gives wallet_configured: false and wallet: null: nothing can be spent from it, and it is not unlimited. A service with no price gives unit_price: null, never zero.

See where credits went

GET /enrichment-credits/usage lists one row for every candidate added to a campaign, newest first. credits is negative when credits were spent and positive when they were given back. summary.net_credits adds up every row that matches your filters, not only the page you are on. An id from another organisation returns an empty list, not an error.
The charge is made in the background right after the campaign is created, so the usage rows can take a moment to appear.

Endpoints