The User API is for operators building their own white-label customer applications on the Wunder Mobility platform. Typical consumers are operator-owned mobile apps and web apps that expose account, discovery, rental, booking, payment, and benefit flows to end users.
Use the User API when an operator-built app is acting for the signed-in end user: managing the user’s account, showing availability, creating a rental or booking, paying, redeeming benefits, or using configured group/business-account features inside the app. If the actor is an operator, administrator, service agent, or internal automation, use the Operations API. If the integration is a MaaS partner integration, start with the MaaS API and MaaS Usage Guide.
| Related reference: User API | Authentication API | Stations User API | Points-Of-Interest User API | Authentication | Error Codes |
| Audience | Typical use cases |
|---|---|
| Operators building white-label mobile apps | Sign-up, sign-in, vehicle discovery, rental lifecycle, booking lifecycle, payments, invoices, packages, subscriptions, vouchers. |
| Operators building white-label web apps | User account management, billing profile, booking flows, configured group/business-account self-service, support attachments. |
| API | Primary actor | Typical traffic pattern | Use it for |
|---|---|---|---|
| User API | Operator-owned white-label end-user app | High-volume app traffic from many users refreshing availability or managing their own account/rentals | Customer-facing mobile or web applications built by an operator. |
| Operations API | Operator, admin, service agent | Lower-frequency operator workflows with richer branch-scoped queries and administrative actions | Fleet management, support, finance, branch administration, operational tooling. |
| MaaS API | MaaS partner/API client | Partner integrations that manage users and mobility flows through a MaaS integration model | MaaS partner integrations. |
The User API is optimized for user-scoped actions. It returns the data the authenticated user is allowed to see and perform. The Operations API is optimized for branch-scoped administration, support, finance, and fleet workflows.
Design User API integrations around app workflows and current-user context.
Accept-Language for localized content and account creation where required.POST /onesignal/session when the app relies on push features such as vehicle radars.Device-Position: {latitude};{longitude} on User API requests when the app has location permission and a fresh user position.POST /userevents only for lightweight app/user telemetry. Do not use it as a source of truth for rental, booking, payment, or vehicle state. See the User API Events Guide.Most User API endpoints use an access token for the current user. Sign-in and token refresh are handled by the Authentication API. Account creation and selected sign-in bootstrap flows are exposed through customer endpoints.
MaaS partner integrations should start with the MaaS API and MaaS Usage Guide. The User API guide focuses on operator-owned white-label apps where the end user signs in directly to the operator’s app experience.
Some public bootstrap endpoints can be called before a user has an access token, such as customer creation, password reset, selected verification-code flows, and public discovery endpoints. Do not assume every read endpoint is anonymous; use the reference for endpoint-specific authorization.
The User API commonly uses these identifiers:
| Identifier | Meaning |
|---|---|
branchId |
Operating branch or home branch context. Many app features are branch-specific. |
vehicleId / vehicleCode |
Vehicle selected from the map or scanned from a QR/code flow. |
vehicleCategoryId |
Vehicle type/category used for discovery, requirements, pricing, booking, and additions. |
rentalId |
Current or historical on-demand rental. |
bookingId |
Scheduled booking/reservation. |
userGroupId / userGroupCode |
Business account/group context for business rentals, bookings, cost centers, and billing. |
balanceId |
Wallet or shared balance available to the user. |
subscriptionCode, packageCode, voucher code |
Commercial benefit identifiers selected by the user. |
Start with the guide that matches the workflow you are building.
| Domain | Guide | Use it for |
|---|---|---|
| Account and authentication | User API Account And Authentication Guide | Sign-up, sign-in support flows, profile, T&C, verification, account deletion, files, localized messages. |
| Discovery and vehicles | User API Discovery And Vehicle Guide | Branches, vehicle map, categories, stations, physical stations, POIs, attributes, settings. |
| Vehicle radars | User API Radar Guide | Saved vehicle-availability alerts for an area, radius handling, notification flow, active radar management. |
| Tutorials | User API Tutorial Guide | In-app tutorial slides, trigger points, category-specific education, show-once and dismissal behavior. |
| Localization | User API Localization Guide | App message resources, localization keys, available languages, custom app copy, fallback handling. |
| Settings | User API Settings Guide | App-area settings, feature flags, branch-scoped configuration, setting keys, client defaults. |
| User events | User API Events Guide | App-posted events, device-position header, app analytics, Operations API event retrieval. |
| Rentals | User API Rental Guide | On-demand rental creation, reservation, start, park, drive, end, checks, additions, damages, feedback, vehicle cards, driving log. |
| Bookings | User API Booking Guide | Scheduled bookings, availability, stations, booking price, pickup, check-in, extension, cancellation. |
| Payments and invoices | User API Payments And Invoices Guide | Payment sources, Apple Pay, Google Pay, PayPal, card redirects, invoices. |
| Commercial products | User API Commercial Products Guide | Index for packages, subscriptions, rate plans, vouchers, promotions, wallet balances, and pricing calculators. |
| Packages | User API Packages Guide | Package catalog, package pricing, package purchase, package-created wallet or voucher benefits. |
| Subscriptions and rate plans | User API Subscriptions And Rate Plans Guide | Subscription catalog, user subscriptions, renewal/cancel/switch, pricing bundle calculators. |
| Vouchers and promotions | User API Vouchers And Promotions Guide | Voucher wallet, voucher-code redemption, selected-vehicle vouchers, geofence promotions. |
| Wallet and balances | User API Wallet, Balances, And Pricing Guide | Wallet display, money/minutes balances, balance history, shared balances, invoice/payment links. |
| Groups and business accounts | User API Groups And Business Accounts Guide | Group membership, group management, member requests, cost centers, group rentals/bookings, billing summary. |
Cross-cutting utility endpoints are documented in the workflow where they are used: files, damages, vehicle cards, and feedback in the Rental Guide; verification and identity cards in the Account And Authentication Guide; vehicle attributes, physical stations, locate, and Bluetooth tokens in the Discovery And Vehicle Guide; push registration in the Radar Guide; message resources in the Localization Guide; and settings in the Settings Guide.
Before implementing a User API integration: