POST
/
v1
/
billValidation
/
parseContract
curl --request POST \
  --url https://api.voltview.co.uk/v1/billValidation/parseContract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data'
{
  "contractId": "<string>",
  "supplierName": "<string>",
  "supplierCode": "<string>",
  "supplierAccountNumber": "<string>",
  "customerName": "<string>",
  "contractNumber": "<string>",
  "contractStartDate": "2023-12-25",
  "contractEndDate": "2023-12-25",
  "isFixedContract": true,
  "isMarketRates": true,
  "isMicroBusiness": true,
  "paymentMethod": "<string>",
  "contractTermMonths": 123,
  "cclRate": 123,
  "vatRate": 123,
  "supplyPoints": [
    {
      "mpanMprn": "<string>",
      "supplyType": "electricity",
      "meterSerialNumber": "<string>",
      "siteName": "<string>",
      "siteAddress": "<string>",
      "standingCharge": 123,
      "standingChargeType": "<string>",
      "unitRate": 123,
      "dayUnitRate": 123,
      "nightUnitRate": 123,
      "estimatedAnnualConsumption": 123,
      "maximumImportCapacity": 123,
      "capacityRate": 123,
      "directDebitDiscount": 123,
      "brokerName": "<string>",
      "brokerUplift": 123
    }
  ],
  "confidence": 123
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

multipart/form-data
​
file
file
required

Contract file (PDF, JPEG, or PNG)

Response

200
application/json
Contract parsed successfully
​
contractId
string
required

Unique contract identifier generated by the system

​
supplierName
string
required

Name of the energy supplier

​
contractNumber
string
required

Official contract reference number

​
confidence
number
required

Confidence score of the extraction (0-100)

​
supplierCode
string

Supplier's identifier code

​
supplierAccountNumber
string

Account number with the supplier

​
customerName
string

Name of the customer on the contract

​
contractStartDate
string

Contract start date (YYYY-MM-DD)

​
contractEndDate
string

Contract end date (YYYY-MM-DD)

​
isFixedContract
boolean

Whether the contract has fixed rates

​
isMarketRates
boolean

Whether rates follow wholesale market prices

​
isMicroBusiness
boolean

Whether the customer is classified as a micro business

​
paymentMethod
string

The agreed payment method

​
contractTermMonths
integer

Duration of the contract in months

​
cclRate
number

Climate Change Levy rate in p/kWh

​
vatRate
number

VAT rate in percentage

​
supplyPoints
object[]

Details of individual meters covered by this contract, each with their specific terms and rates