v1

latestOpenAPI 3.0.3Proprietary2026-07-136748169.6 KB

Bill Validation

Contract Parsing

Parse contract

Upload and process a UK energy supplier contract (PDF or images) to extract contract details, supply points (MPANs/MPRNs), and associated tariff information.

post/v1/billValidation/parseContract

Response

Contract successfully parsed

customerType'domestic' | 'non_domestic' nullable

Customer classification - residential (domestic) or business (non_domestic)

supplierAccountNumberstring nullable

Supplier account number

supplierNamestring nullable

Name of the supplier

supplierAddressstring nullable

Supplier's full address

supplierCodestring nullable

Supplier code

customerNamestring nullable

Name of the customer

billingAddressstring nullable

Address where bills are sent (customer's address)

contractNumberstring nullable

Contract number

contractStartDatestring date nullable

Contract start date (YYYY-MM-DD)

contractEndDatestring date nullable

Contract end date (YYYY-MM-DD)

cclRatenumber nullable

Climate Change Levy (CCL) rate

isFixedContractboolean nullable

Whether this is a fixed-rate contract

isMarketRatesboolean nullable

Whether this contract uses market rates

isMicroBusinessboolean nullable

Whether the customer is classified as a micro business

paymentMethodstring nullable

Payment method

contractTermMonthsnumber nullable

Contract term in months