Admin Dashboard Guide
The Admin Dashboard is an internal platform for client & module management. Access Admin Dashboard
See Admin Dashboard Access for roles, the request flow, and internal config keys.
What's on this page
- Core concepts — clients, BUs, AppIDs, and the account status lifecycle.
- Client management — day-to-day client tasks (creating clients, updating details, credentials, deactivation, module linking).
- Contracts & HyperStart — how production-credential creation is gated.
- Module management — adding and editing modules.
Core concepts
Clients, Business Units (BUs) & AppIDs
The hierarchy is: Client → BU(s) → AppID(s).
| Term | Definition |
|---|---|
| Client | The organisation using HyperVerge's products — e.g., Swiggy, Grab, Hero Fincorp. |
| Business Unit (BU) | A sub-unit under a client. A client can have one or many. |
| AppID | Credentials a BU uses to call HyperVerge APIs. Each AppID is either staging (dev/testing) or production (live end-customer traffic). |
When a client is created:
- A BU named
Defaultis automatically created. - A staging AppID is automatically created under that BU.
When a BU is ready for production:
- The account owner adds production credentials from the Admin Dashboard (see Creating production credentials below).
When to create additional BUs:
A client typically gets multiple BUs when they operate across distinct axes, such as:
- Different financial products — e.g., Hero Fincorp: two-wheeler loan, instant personal loan, loyalty personal loan.
- Multiple channels — e.g., insurance clients with Direct, PayTM, PhonePe channels.
- Different internal channels — e.g., FEC: personal loan on Vymo vs. Robo.
- Different geographies under overlapping teams — e.g., Grab Vietnam vs. Grab Malaysia.
- Different use cases with different platform fees — e.g., Swiggy: agent auth vs. agent onboarding vs. customer onboarding.
New BUs can be added from the Client Details page.
Anatomy of a client profile
Once you open a client from the Admin Dashboard, these tabs are available:
| Tab | What it shows |
|---|---|
| Client Details | View/manage client details, BUs, AppIDs. |
| Usage | Monthly usage and costs per module. |
| Pricing Info | Pricing slabs and per-unit costs. |
| Invoices | Invoices, payment status, historical records. |
| Contracts | Redirects to HyperStart for client contracts. |
| Revenue Trends | Growth patterns and client contribution. |
| Change History | Audit trail of pricing and client updates. |
Account status lifecycle
Every client progresses through a set of account statuses:
| Status | Description | Who sets it | Notes |
|---|---|---|---|
| Trial | Time-bound staging access. Auto-expires in 15 days unless extended. | Auto (on client creation) | Account Owner can extend the trial through the Dashboard. |
| Active | Unrestricted staging access, no expiry. | Account Owner, manually via Dashboard | See the warning below. |
| Live | Auto-set when first production credentials are created. | Auto (on first production AppID) | Cannot be updated manually once Live. |
| Inactive | All staging & production credentials disabled. Not shown by default (use filters). | Slack request to #process-disable-credentials | Deactivation must go through Slack — no dashboard flow. |
Once a client is upgraded to Active, they have unrestricted staging access with no expiry. This means clients may go live on staging credentials without a production contract in place.
Client management
Creating a new client
Only Account Owners can create new clients. For the full walkthrough (field-by-field reference, advanced options, access troubleshooting), see Creating New Clients.
Updating client details
Only the Account Owner has access to modify details.
| Field category | Fields | Notes |
|---|---|---|
| Client Details | Client Name, Account Owner, Billing Type, Currency, Account Status | Currency is auto-set based on Client Geography at creation — INR for Indian clients, USD otherwise. Not directly editable. |
| Pricing Details | Module Pricing, Platform Pricing, Minimum Monthly Commitment | See Taking a Client Live for the end-to-end pricing setup. |
| Invoicing Details | Zoho ID linkage at Admin Dashboard → Invoices Tab | Each client can have multiple invoices (configured at BU-level — not directly from the dashboard). |
Billing Type is an editable field but never defined. What are the valid values? What determines which one to pick for a given client?
Extending a trial
Account Owners can extend the 15-day Trial window directly from the Dashboard on the client's profile.
Add the step-by-step: which screen/button triggers the extension, and whether there's a max cap on how long the extension can be.
Creating production credentials
See Taking a Client Live for the full end-to-end walkthrough — HyperStart contract check, linking the Client ID, setting up pricing, and generating the production AppID.
Deactivating a client or credentials
Deactivation is not available from the Admin Dashboard. Raise a request in #process-disable-credentials on Slack — this is the only path to flip a client to Inactive.
Linking modules to a client
Module access is determined at two levels:
- Authorized Products — set at client creation (or later under Client Details). The top-level toggles are HVOne Dashboard and Video KYC (see Creating New Clients).
- Module availability — within the authorized product, a client can call any module that's been registered in the Admin Dashboard by a Module Owner. For a client to be billed correctly for a module they're calling, per-module pricing must be configured (see Taking a Client Live).
There is no per-client module allowlist beneath the Authorized Products toggle — module calls succeed as long as the product is authorized and the module is registered. For module-side setup (adding, editing, Unit IDs, Billable Status Codes), see Managing Modules.
Contracts & HyperStart
Before production credential creation, the HyperStart contract repository is checked for a valid contract against the Client ID.
Common mistakes even when a contract exists:
- Client ID on HyperStart does not match Admin Dashboard
- Client ID on HyperStart has extra whitespace
Module management
For the Modules Tab on the Admin Dashboard — adding new modules, editing them, terminology, and FAQs — see Managing Modules.