API Reference

Submit an Enrollment

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

Submits an Enrollment for the given Program.

Any Enrollment created via this path requires vendor approval, and so
will begin with the status pendingvendor.

When using the pairingcode flow, clients can avoid duplicate submissions using
the specified Idempotency-Key header. Appropriate values are non-PII customer
identifiers which guarantee a unique customer on the clients' end. Neither
the deviceIdentifier nor the utilityAccountNumber fields are allowed in this flow.

When using the preapproved flow, the Idempotency-Key header is ignored.
The deviceIdentifier and utilityAccountNumber fields in combination obviate the
need for it in this flow. The deviceIdentifier field is required in this flow,
and the utilityAccountNumber field is optional.

Body Params
string
required
^prog-[a-z0-9]+$

A Derapi Program ID

site
required
tags
object

A set of client-defined key-value pairs that can be attached to an object. Tags can be used for
filtering and organization.

Tags should not be used to store sensitive information (e.g., personally identifiable information or
authentication data).

A maximum of 10 tags can be attached to an object

Keys:

  • case sensitive
  • can only contain URL unreserved characters (letters, digits, hyphens, periods, underscores, and tildes)
  • at most 30 characters long

Values:

  • case sensitive
  • can contain any UTF-8 character (but must be escaped in query parameters)
  • at most 100 characters long
Headers
string

A unique key that allows the client to make the request idempotent.
If a request with the same key has already been processed, the server
will return the original response without performing the operation again.

Do not include PII (Personally Identifiable Information) in this value.
Use a random or opaque identifier such as a UUID or secure hash.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Idempotency-Key
and https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
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

Did this page help you?