Supplier Integration

Create an Account

Create an account with credentials for the utility website. The service will use these details to log in and scrape data.

post/v1/suppliers/accounts

Request body

emailstring email

Email for utility supplier account

passwordstring

Password for utility supplier account

referenceIdstring

Business identifier

supplierstring

Type of utility supplier

expiryDatestring date-time

Optional expiration date for account credentials

isTestboolean

Optional. Marks the account as a test account. Test accounts are deleted after 30 days.

Account created successfully

referenceIdstring

Reference identifier

idstring

Account identifier

status'PASSING' | 'FAILING'

Account connection status

reasonstring

Reason for failing

isTestboolean

Test accounts are deleted after 30 days.

createdAtstring date-time

Date the account was created