Skip to main content
POST
Create an Account

Authorizations

x-api-key
string
header
required

VoltView API key

Body

application/json
email
string<email>

Email for utility supplier account

password
string

Password for utility supplier account

referenceId
string

Business identifier

supplier
string

Type of utility supplier

expiryDate
string<date-time>

Optional expiration date for account credentials

isTest
boolean

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

Response

Account created successfully

referenceId
string

Reference identifier

id
string

Account identifier

status
enum<string>

Account connection status

Available options:
PASSING,
FAILING
reason
string

Reason for failing

isTest
boolean

Test accounts are deleted after 30 days.

createdAt
string<date-time>

Date the account was created