Skip to main content
POST
/
v1
/
suppliers
/
accounts
Create an Account
curl --request POST \
  --url https://api.voltview.co.uk/v1/suppliers/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "jsmith@example.com",
  "password": "<string>",
  "referenceId": "<string>",
  "supplier": "<string>",
  "expiryDate": "2023-11-07T05:31:56Z",
  "isTest": true
}'
{
  "referenceId": "<string>",
  "id": "<string>",
  "status": "PASSING",
  "reason": "<string>",
  "isTest": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

application/json
​
email
string<email>
required

Email for utility supplier account

​
password
string
required

Password for utility supplier account

​
referenceId
string
required

Business identifier

​
supplier
string
required

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