Skip to main content
POST
/
v1
/
loas
Create LOA
curl --request POST \
  --url https://api.voltview.co.uk/v1/loas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "id": "<string>",
  "status": "PENDING",
  "businessId": "<string>",
  "customerName": "<string>",
  "customerAddress": "<string>",
  "filePath": "<string>",
  "authorizedPersons": [
    {
      "id": "<string>",
      "name": "<string>",
      "company": "<string>",
      "role": "<string>"
    }
  ],
  "supplyPoints": [
    {
      "id": "<string>",
      "mpanMprn": "<string>",
      "supplyType": "electricity",
      "address": "<string>",
      "meterId": "<string>"
    }
  ],
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25",
  "signatureDate": "2023-12-25",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

multipart/form-data
file
file
required

LOA document file(s) - supports PDF, JPG, PNG. Upload one PDF or multiple images (up to 10).

Response

LOA created successfully

id
string
required

LOA identifier

status
enum<string>
required

LOA status

Available options:
PENDING,
SENT,
SIGNED,
EXPIRED,
REJECTED
businessId
string

Associated business identifier

customerName
string

Customer/business name

customerAddress
string

Customer address

filePath
string

Path to stored LOA document

authorizedPersons
object[]
supplyPoints
object[]
validFrom
string<date>
validTo
string<date>
signatureDate
string<date>
createdAt
string<date-time>
updatedAt
string<date-time>