Documentation / Dashboard usage

Dashboard usage

View your company's quota and request counts without exposing OCR data.

The private dashboard is a read-only view of your company's usage. It uses a private, revocable access code supplied separately from your OCR API key. Contact ecodevcontact@gmail.com to obtain access or arrange revocation.

Do not enter an OCR API key in the dashboard login. The dashboard code does not authorize extraction requests.

Sign in and sign out

Open the dashboard on the service's own website and enter the access code. A successful login creates a session lasting up to eight hours. Viewing usage does not extend that deadline. Sign in again after expiry, and sign out when using a shared device.

The session uses an HttpOnly, Secure, SameSite=Strict cookie. The dashboard does not need your API key. Sign-out ends the current browser session; it does not sign out other browsers. Support can rotate or revoke the access code to invalidate all its sessions. Revoking the underlying API client also denies dashboard access.

This is company access, not an individual employee account. Share the private code only with authorized colleagues. Repeated login attempts are limited; if access is temporarily rate-limited, wait for the indicated retry interval.

Read your usage

The dashboard can show the current UTC calendar month and the previous eleven months.

ItemMeaning
CompanyThe account attached to the dashboard code.
Monthly allowanceThe company's configured reading limit.
Reserved attemptsAll jobs accepted for processing, including technical failures that were later credited.
Billable usageUnits currently used after credits; processing jobs occupy a unit.
CreditedAccepted attempts whose technical failure released the unit.
RemainingThe allowance still available after billable usage.
SucceededJobs that returned a reading; their values still require review.
FailedAccepted jobs that ended without a result; this count includes credited technical failures and billable unreadable results.
ProcessingJobs recorded as starting or pending; this does not prove an inference is still running.
Daily usageAll accepted attempts grouped by UTC date, including credited failures; this is not the billable-unit total.
Recent requestsUp to 25 recent request identifiers, statuses and creation times in the selected month.

The dashboard also shows the account's current per-minute and concurrent limits. Basic, Pro and Plus currently use ten new readings per minute and two active readings per company.

UTC dates can differ from the local date at the time a request was submitted. The application currently counts usage by UTC calendar month, even when commercial billing is annual.

Historical usage is compared with the company's current configured limit. The system does not store past plan-limit snapshots, so a previous month's displayed allowance or remaining amount is not a reconstruction of that month's contract. Daily counts and recent activity are current observations rather than a frozen accounting export.

What is excluded

The dashboard does not display INE photographs, extracted names, CURPs, addresses, MRZ text or API keys. Request identifiers are operational metadata and should still be shared only where needed.

This is not an image-upload interface, billing portal, key-management screen or identity-verification tool. Plan changes, payments, new access codes and credential revocation are handled through support. Use the backend API for extraction and result retrieval.