# Hypervolt User API

**Canonical:** https://apis.io/apis/hypervolt/hypervolt-user-api/  
**Provider:** Hypervolt — https://apis.io/providers/hypervolt/  
**Base URL:** https://api.hypervolt.co.uk/  
**Documentation:** https://hypervolt.co.uk/en-US/

Hypervolt User API is one of 16 APIs that [Hypervolt](https://apis.io/providers/hypervolt/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 3 JSON Schema definitions. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and 3 JSON Schemas.

The user API from Hypervolt — 13 operation(s) for user.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| GET | `/users/{userId}` | Get user details |
| GET | `/users/by-email/{email}` | Get user details by email |
| GET | `/users/{userId}/consents` | Get user consents |
| PUT | `/users/{userId}/consents` | Create or update user consents |
| GET | `/users/{userId}/flex-payout-account` | Get the payment account details for the keycloak user |
| POST | `/users/{userId}/flex-payout-account` | Creates a payment account and binds it to the keycloak user in athena |
| POST | `/users/{userId}/push/register` | Register FCM push notification token |
| GET | `/users/{userId}/preferences` | Get the user preferences |
| POST | `/users/{userId}/preferences` | Set the user preferences |
| GET | `/users/{userId}/silent-push-message` | Get the latest unread silent push message for the current user |
| GET | `/users/{userId}/silent-push-messages` | Get the latest unread silent push messages for the current user |
| GET | `/users/{userId}/past-push-notifications` | Get past push notifications received by the current user |
| POST | `/users/{userId}/app-metadata` | Stores app config flags for a user |
| POST | `/signup` | Signup a new user, which creates a KC User |
| POST | `/password-reset` | Send reset password email |
| GET | `/login-status` | Determine the login status of the user (see CLOUD-2460) |

## Machine-readable artifacts (4)

- **OpenAPI** — https://artifacts.apis.io/hypervolt/openapi/hypervolt-user-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/hypervolt/json-schema/hypervolt-placement-json-schema.json
- **JSONSchema** — https://artifacts.apis.io/hypervolt/json-schema/hypervolt-consent-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hypervolt/json-schema/hypervolt-user-json-schema.json

## Other Hypervolt APIs (12)

- [Hypervolt Account API](https://apis.io/apis/hypervolt/hypervolt-account-api/)
- [Hypervolt Address API](https://apis.io/apis/hypervolt/hypervolt-address-api/)
- [Hypervolt Adoption API](https://apis.io/apis/hypervolt/hypervolt-adoption-api/)
- [Hypervolt Adoption Codes API](https://apis.io/apis/hypervolt/hypervolt-adoption-codes-api/)
- [Hypervolt Analytics API](https://apis.io/apis/hypervolt/hypervolt-analytics-api/)
- [Hypervolt Charger API](https://apis.io/apis/hypervolt/hypervolt-charger-api/)
- [Hypervolt Flex Registration Activity Summary API](https://apis.io/apis/hypervolt/hypervolt-flex-registration-activity-summary-api/)
- [Hypervolt JWT Refresh API](https://apis.io/apis/hypervolt/hypervolt-jwt-refresh-api/)
- [Hypervolt Metrics API](https://apis.io/apis/hypervolt/hypervolt-metrics-api/)
- [Hypervolt Ota API](https://apis.io/apis/hypervolt/hypervolt-ota-api/)
- [Hypervolt Other API](https://apis.io/apis/hypervolt/hypervolt-other-api/)
- [Hypervolt Placement API](https://apis.io/apis/hypervolt/hypervolt-placement-api/)

## Tags

User

## Use this from code or an agent

- **REST, no key:** `GET https://apis.io/api/v1/providers/hypervolt` returns the provider's full profile as JSON.
- **MCP:** `https://apis.io/mcp` (Streamable HTTP) — search the catalog, read any provider, compare providers, check agent readiness.
- **Free API key** for catalog-wide search, ratings and comparisons: sign in with GitHub, Google or LinkedIn at https://apis.io/developer/account/ (plans: https://apis.io/developer/plans/).

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hypervolt/hypervolt-user-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hypervolt/.
