Documentation

Quickstart

1. Create an account and verify your email.
2. Create a sandbox key under API keys and call any API for free sample data.
3. Activate access (plan or approval), fund your wallet, then create a live key.
4. Call the API from your server and handle the response envelope below.

curl -X POST https://api.parzivalhub.com/v1/rc-details \
  -H "Authorization: Bearer pzk_test_YOUR_SANDBOX_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vehicle_number":"MH12AB1234"}'

Authentication

Every request carries an API key in a header. Keys start with pzk_live_ (real data, billable) or pzk_test_ (sandbox).

Authorization: Bearer pzk_live_xxxxxxxxxxxxxxxx
# or
X-API-Key: pzk_live_xxxxxxxxxxxxxxxx

Keys sent in the URL query string are rejected with KEY_IN_URL, because URLs end up in logs and browser history. Keys are shown once at creation and stored by us only as a one-way hash.

Requests

Base URL: https://api.parzivalhub.com/v1. Each API lives at /v1/<api-slug>. Unless an API says otherwise, send POST with a JSON body; parameter names are listed per API. Inputs such as vehicle numbers are normalised for you (case, spaces and dashes don't matter).

Responses

All APIs share one envelope. Check success first, keep request_id for support, and read billing in meta.

{
  "success": true,
  "request_id": "req_4fG8…",
  "status": "found",
  "data": {
    "…": "API-specific fields"
  },
  "meta": {
    "api": "rc-details",
    "latency_ms": 412,
    "charged": 0,
    "quota_remaining": 980,
    "access_expires_at": "2026-12-31T18:29:59Z"
  }
}

{
  "success": false,
  "request_id": "req_9xP2…",
  "error": {
    "code": "RECORD_NOT_FOUND",
    "message": "No record was found for this input."
  }
}

Fields the source does not have are returned as null. Dates are ISO YYYY-MM-DD. Personally identifying values may be partially masked depending on your access.

Errors

Errors use standard HTTP status codes plus a stable error.code. Errors are never charged.

Rate limits & quotas

Each key has a per-minute limit per API, and each account has an overall per-minute limit. Exceeding either returns 429 RATE_LIMITED with a Retry-After header. Plans can also carry a total request quota and a daily cap (resets at midnight IST). Use exponential backoff for 429, 502 and 504.

Sandbox

Sandbox keys (pzk_test_) return the documented sample response for any API, instantly and free, so you can build and test parsing before going live. Sandbox responses include "sandbox": true.

Billing & validity

Your account has a prepaid wallet and per-API access. Access is granted by validity plans (for example 30 or 90 days with an included number of requests) or by custom packages arranged with our team. When an API carries a per-request rate, it is deducted from your wallet only when the lookup succeeds; the exact amount is returned in meta.charged and listed in your transaction history. Rates are shown in your dashboard.

Account endpoint

Check your wallet balance and the validity and remaining quota of each API programmatically. Free; limited to 30 calls per minute.

curl https://api.parzivalhub.com/v1/me -H "Authorization: Bearer pzk_live_YOUR_KEY"

Security checklist

• Call the API only from your servers. Never embed a key in a web page or mobile app.
• Restrict live keys to your server IPs and to the APIs each service needs.
• Use separate keys per environment and service; roll a key immediately if it may have leaked.
• Turn on two-factor authentication for every dashboard user.
• Store only the fields you need, and only for as long as your purpose requires.

API reference

Loading…