FlipFlip Aggregator API
Commissioning

Commission a site and devices

Register a new site and its devices into Flip.

If the site requires additional information to complete setup (such as terms and conditions acceptance), the API returns a 422 response detailing what is needed — collect that information and retry.

POST
/v1/commission

Request Body

devicesarray<object>

One or more devices to commission at the site. At least one device is required.

Items1 <= items
siteobject

The site (customer location) to commission. Provide as much address and contact information as possible — this is used for program matching and enrollment.

Response Body

curl -X POST "https://aggregator-api.flip.energy/v1/commission" \  -H "Content-Type: application/json" \  -d '{    "devices": [      {        "id": "device-xyz-123",        "install_date": "2025-06-19T15:30:00Z",        "technology_provider_identifier": "DURACELL",        "type": "BATTERY"      }    ],    "site": {      "id": "site-abc-789"    }  }'
Empty
{
  "code": "VALIDATION_ERROR",
  "error": "Bad Request",
  "message": "devices array must not be empty",
  "statusCode": 400
}
{
  "code": "string",
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ],
  "errors": [
    {
      "message": "string",
      "path": "string"
    }
  ],
  "message": "string",
  "status_code": 0
}
Empty
{
  "enrollment": {
    "incorrect_terms_and_conditions_version": true,
    "missing_has_agreed_to_terms_and_conditions": true,
    "missing_program_specific_attributes": [
      {
        "error": "string",
        "hint": "string",
        "label": "string",
        "name": "string",
        "type": "boolean"
      }
    ],
    "missing_site_attributes": [
      "string"
    ],
    "missing_terms_and_conditions_version": true
  }
}