Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API
The utility commissioned [pairing code](./device-partner-api.html#section/Pairing-Codes) flow could work as follows:1. The device owner fills out an onboarding form on Virtual Peaker's site.2. The utility reviews the submission and approves it if eligible.3. Virtual Peaker informs the Device Partner of the install address and provides a pairing code.4. The Device Partner takes necessary actions to install and activate the device on-site.5. When installation is complete, the Device Partner publishes a device enrollment event to Virtual Peaker.6. The publish includes the pairing code to link with the onboarding form.7. If multiple devices are installed, the same code is used in each payload.8. Virtual Peaker discovers user details for the enrolled device(s).9. We subscribe to the device(s) for data publishing and provide a `DEVICE_PUBLISH_SECRET`.In this flow, the utility directs the installation. The pairing code links the user signup, Device Partner platform, and Virtual Peaker after install. The flow described above can have slight variations depending on the use case.
Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API is one of 8 APIs that Virtual Peaker publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, an engineering blog, and a getting-started guide.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 2.0.6.
Requests are made against a single base URL, https://example.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (device_partner_api_auth) using the clientCredentials flow, exposing 1 scope.
It supports OAuth 2.0 (device_partner_user_auth) using the authorizationCode flow, exposing 1 scope.
By default, every request must be authenticated.
device_partner_user_auth— If using the OAuth onboarding method, this authentication method is used for the respective endpoints. Please the the FAQ for more details.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The utility commissioned [pairing code](./device-partner-api.htmlsection/Pairing-Codes) flow could work as follows: 1. The device owner fills out an onboarding form on Virtual Pea…
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UserDetails (6 properties), ServiceAddress (6 properties), Details (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Virtual Peaker 7
Other APIs Virtual Peaker publishes across the network.
This is an independent, third-party profile of Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.