> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voltview.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Create LOA

> Parse and save a Letter of Authority document. Uploads PDF to storage, links supply points to existing meters (if found), and saves to database. Uses content-based deduplication (returns existing LOA if identical file was already uploaded). Triggers background onboarding stages after saving.



## OpenAPI

````yaml post /v1/loas
openapi: 3.0.3
info:
  title: VoltView API
  description: >-
    The VoltView API provides comprehensive energy monitoring and management
    capabilities for multi-site businesses, enabling real-time tracking of
    energy consumption, cost analysis, and environmental impact metrics.


    Our API suite includes:

    - Site Management API - Manage and monitor multiple site locations

    - Energy Consumption API - Access detailed energy usage data

    - Cost Analysis API - Track and analyse energy costs

    - Environmental Metrics API - Monitor carbon emissions and energy efficiency

    - Bill Validation API - Validate and audit utility bills for accuracy

    - Supplier Integration API - Integrate with utility suppliers for automated
    data collection


    ## Getting started guide


    To start using the VoltView API, you need to:


    - Sign up for a VoltView account to receive your API credentials

    - Review our data granularity options (hourly/daily/monthly)

    - Ensure your requests are sent via HTTPS

    - All responses are returned in JSON format


    ## Authentication


    Include your VoltView API key in the `x-api-key` header on every request.


    ### Authentication error response

    If authentication fails, you will receive an HTTP 401 Unauthorised response
    with a detailed error message in the JSON response body.


    ## Data Units

    - Energy Consumption: kWh

    - Power Demand: kW

    - Carbon Emissions: kg CO2e/tonnes CO2e

    - Currency: GBP (£)

    - Time Series: ISO 8601 format

    - Numeric Values: Rounded to 2 decimal places
  version: 1.0.0
  contact:
    email: info@voltview.co.uk
  license:
    name: Proprietary
servers:
  - url: https://api.voltview.co.uk
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Authentication
    description: Endpoints for authentication
  - name: User
    description: User profile management
  - name: Sites
    description: Multi-site management endpoints
  - name: Energy Consumption
    description: Energy consumption data endpoints
  - name: Specific Site
    description: Operations for specific sites
  - name: Meters
    description: Meter lookup and meter readings management
  - name: Emissions
    description: Carbon emissions data endpoints
  - name: LOA Management
    description: >-
      Letter of Authority (LOA) management - create, list, view, and update
      status of LOAs
  - name: Supplier Integration
    description: Utilities integration endpoints
  - name: Billing Insights
    description: Account-level billing insights and bill assurance opportunities
  - name: Bill Validation
    description: Utility bill validation and error detection endpoints
paths:
  /v1/loas:
    post:
      tags:
        - LOA Management
      summary: Create LOA
      description: >-
        Parse and save a Letter of Authority document. Uploads PDF to storage,
        links supply points to existing meters (if found), and saves to
        database. Uses content-based deduplication (returns existing LOA if
        identical file was already uploaded). Triggers background onboarding
        stages after saving.
      operationId: createLOA
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    LOA document file(s) - supports PDF, JPG, PNG. Upload one
                    PDF or multiple images (up to 10).
              required:
                - file
      responses:
        '200':
          description: LOA created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LOA'
        4XX:
          $ref: '#/components/responses/Error4XX'
components:
  schemas:
    LOA:
      type: object
      properties:
        id:
          type: string
          description: LOA identifier
        businessId:
          type: string
          description: Associated business identifier
        customerName:
          type: string
          description: Customer/business name
        customerAddress:
          type: string
          description: Customer address
        status:
          type: string
          enum:
            - PENDING
            - SENT
            - SIGNED
            - EXPIRED
            - REJECTED
          description: LOA status
        filePath:
          type: string
          description: Path to stored LOA document
        authorizedPersons:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              company:
                type: string
              role:
                type: string
        supplyPoints:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              mpanMprn:
                type: string
              supplyType:
                type: string
                enum:
                  - electricity
                  - gas
              address:
                type: string
              meterId:
                type: string
                description: Linked meter ID if found
        validFrom:
          type: string
          format: date
        validTo:
          type: string
          format: date
        signatureDate:
          type: string
          format: date
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  responses:
    Error4XX:
      description: Client error response
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                enum:
                  - error
              error:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - invalid_request_error
                  message:
                    type: string
                    default: Invalid request
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: VoltView API key

````