Sign in
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

filePathstring

Generated file path for the contract

customerType'domestic' | 'non_domestic'

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

supplierAccountNumberstring

Supplier account number

supplierNamestring

Name of the supplier

supplierAddressstring

Supplier's full address

supplierIdstring

Internal supplier identifier

supplierCodestring

Supplier code

customerNamestring

Name of the customer

billingAddressstring

Address where bills are sent (customer's address)

contractNumberstring

Contract number

contractStartDatestring date

Contract start date in YYYY-MM-DD format

contractEndDatestring date

Contract end date in YYYY-MM-DD format

cclRatenumber

Climate Change Levy (CCL) rate in pence per kWh (p/kWh). Converted from £/kWh if necessary (e.g., 0.00775 £/kWh becomes 0.775 p/kWh).

isFixedContractboolean

Whether this is a fixed-rate contract

isMarketRatesboolean

Whether this contract uses market rates

isMicroBusinessboolean

Whether the customer is classified as a micro business

paymentMethodstring

Payment method (e.g., 'Direct Debit', 'Credit Card')

contractTermMonthsnumber

Contract term in months

Changes