API Reference

Create a Virtual Enrollment

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

Create a Virtual Enrollment test configuration in the current sandbox.

Body Params
string
required

The program ID for this enrollment

date-time

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

string

The utility account number associated with this application.

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
string

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

string
enum
Defaults to applied
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 3 months ago