# Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API

**Canonical:** https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-utility-commissioned-installation-api/  
**Provider:** Virtual Peaker — https://apis.io/providers/virtual-peaker/  
**Base URL:** https://partner.virtualpeaker.io/v1  
**Documentation:** https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html

Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API is one of 8 APIs that [Virtual Peaker](https://apis.io/providers/virtual-peaker/) publishes on the [APIs.io](https://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.

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.

## Operations (2)

| Method | Path | Summary |
|---|---|---|
| GET | `/device/{DEVICE_UID}/user` | Describe device's user |
| POST | `/houses` | Publish houses for installation |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/virtual-peaker/refs/heads/main/openapi/virtual-peaker-pairing-code-device-discovery-utility-commissioned-installation-api-openapi.yml
- **APIReference** — https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html
- **Documentation** — https://virtual-peaker.com/partners/device-partners/
- **Blog** — https://virtual-peaker.com/blog/gravity-connect-api-oem-derms-integrations/
- **GettingStarted** — https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html#section/Getting-Started
- **APIReference** — https://assets.virtualpeaker.io/gravity-connect/vp-api.html
- **Documentation** — https://virtual-peaker.com/apis/
- **Blog** — https://virtual-peaker.com/blog/gravity-connect-v-openadr/
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/virtual-peaker/refs/heads/main/asyncapi/virtual-peaker-gravity-connect-webhooks.yml

## Other Virtual Peaker APIs (7)

- [Virtual Peaker Commands API](https://apis.io/apis/virtual-peaker/virtual-peaker-commands-api/)
- [Virtual Peaker Devices API](https://apis.io/apis/virtual-peaker/virtual-peaker-devices-api/)
- [Virtual Peaker Energy Interval Endpoint API](https://apis.io/apis/virtual-peaker/virtual-peaker-energy-interval-endpoint-api/)
- [Virtual Peaker Group Management API](https://apis.io/apis/virtual-peaker/virtual-peaker-group-management-api/)
- [Virtual Peaker OAuth Device Discovery (Preferred) API](https://apis.io/apis/virtual-peaker/virtual-peaker-oauth-device-discovery-preferred-api/)
- [Virtual Peaker Pairing Code Device Discovery - End User App API](https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-end-user-app-api/)
- [Virtual Peaker Publishing API](https://apis.io/apis/virtual-peaker/virtual-peaker-publishing-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-utility-commissioned-installation-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/virtual-peaker/.