Account Overview
Verify your API key and check credit balance with the PerfectParser Account API.
The Account endpoints let you confirm your API key is valid and inspect your credit balance before submitting extraction jobs.
Endpoints
| Endpoint | Description |
|---|---|
| Get Account | GET /v1/me — user identity, key metadata, and available credits |
| Get Credits | GET /v1/credits — detailed credit balance and active purchases |
When to use
| Scenario | Endpoint |
|---|---|
| Health check after deploying an integration | GET /v1/me |
| Pre-flight check before a large batch | GET /v1/credits |
| Display balance in your admin UI | Either — GET /v1/me includes credits_available; GET /v1/credits includes purchase breakdown |
Related
- Credits & Billing guide — how credits are consumed and purchased.
- Start Extraction — submit documents (charges credits per page).