Create a Virtual Enrollment

post

https://api.derapi.com/virtual/enrollments

Create a Virtual Enrollment test configuration in the current sandbox.

Body Params

Fields to create a virtual Enrollment. Based on Enrollment application data but without calculated fields.

initialApplicationState controls how this Enrollment is created.

if initialApplicationState is not provided, it will default to "applied".
customer data can either be provided or will be inferred.
if initialApplicationState is "preapplication", no system or customer data will be associated;
any provided in the request will be ignored

programID

string

required

^prog-[a-z0-9]+$

The program ID for this enrollment

appliedAt

date-time

Date and time customer submitted their application in ISO-8601 format with timezone

utilityAccountNumber

string

The utility account number associated with this application.

customerAcceptedTerms

const

enum

Defaults to true

Whether the user accepted terms

Allowed:

customer

object

Information about customer whose application it is

address

object

The address of the site in the application.

additionalInfo

object

Additional information about the latest application, which may be retrieved on later calls
loading the Enrollment.

Maximum of 50 keys. Keys are limited to 100 bytes, values to 250 bytes.

systemInfo

object

siteID

string

^site-[a-z0-9]+$

The enrolled site, if known; if not provided, one will be created.

initialApplicationState

string

enum

Defaults to applied

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Created

400Too many virtual resources

422A validation error