Hifi User API is one of 15 APIs that Hifi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 6 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
Requests are made against 2 base URLs: https://production.hifibridge.com, https://sandbox.hifibridge.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hifi User API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
User endpoints
Schemas 15
The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are IndividualUserV2Create (10 properties), BusinessUserV2Create (9 properties), IndividualUserV2Update (8 properties), BusinessUserV2Update (7 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hifi 12
Other APIs Hifi publishes across the network.