Skip to content

Credits / Wallet ​

Read-only (GET) endpoints for the authenticated user's credit balance. They are free (they don't consume credit) and available with your Bearer token — no configured origin whitelist is required.

Auth: Authorization: Bearer <api_token> header on every call. Base URL: https://api.dokicasa.it (production) · https://api-dev.dokicasa.it (sandbox).

Credits by group ​

GET /api/users/me/credits

The user's available credits, aggregated by service group (electronic signature, land registry reports, ...) and by origin. Only non-expired credits are counted: the ones already spent stay in the count as used.

json
[
  { "group": "Firma Elettronica", "used": 3, "total": 10, "source": "smart", "is_unlimited": false },
  { "group": "Visure catastali",  "used": 0, "total": 5,  "source": "single", "is_unlimited": false }
]
FieldTypeNotes
groupstringService group. Credits with no group fall into Altri crediti
totalintegerCredits in the group (spent ones included)
usedintegerHow many have already been spent
sourcestringsmart (included in Dokicasa Smart) · market_scanner · single (bought separately)
is_unlimitedbooleantrue = the plan makes the group unlimited: show "unlimited" instead of the count

The same group can appear in several rows with a different source: signatures included in the subscription and signatures bought separately stay counted apart.

QueryDefaultNotes
only_dokicasa_smartabsent1 = only credits included in a Dokicasa Smart subscription. Without it those credits are excluded

If you'd rather pass your own id, GET /api/users/{id}/credits answers the same way, but the id must be the one of the token's user: otherwise the response is 403.

Wallet balance ​

GET /api/users/me/wallet

Returns the user's balance, including expected future costs (scheduled jobs and pending censimenti).

json
{
  "wallet": 120.00,
  "real_wallet": 89.50
}
FieldTypeNotes
walletnumberCurrent nominal wallet balance
real_walletnumberActually spendable balance, net of already-committed (pending) costs

Transactions history ​

GET /api/users/me/wallet-transactions

Paginated history of wallet movements (most recent first).

QueryDefaultNotes
per_page20items per page
page1page to read

Response: Laravel paginator — { current_page, data: [ … ], per_page, total, last_page, … }.

Quick try (curl) ​

bash
curl https://api-dev.dokicasa.it/api/users/me/wallet \
  -H "Authorization: Bearer HfBfYShns3E02no3kkwCRWQugkVNcJCtrRN2BPoI5NxhqsiXaxxnSPpIHY2O"
# → { "wallet": 120.00, "real_wallet": 89.50 }

TIP

You can try them right away with the test token on the sandbox: they are read-only, free calls.