Documents
Intro
After enrollment, you will need to provide the customer with important documents related to their service. These documents include the Electricity Facts Label (EFL), Terms of Service (TOS), and Your Rights as a Customer (YRAC).
These documents are also included in the /v1/app/accounts/enroll/plans/request response payload when the customer is enrolling in a plan.
Embedded Flow
Embedded Flow lets you skip all of the UI work needed to share documents. Use the documents scope to surface this specific experience. Learn more
API
The API requires you retrieve a user's AccountToken for the document experience. Refer to the authentication docs for more details.
Get active documents for a location
To retrieve a list of active documents for a specific location, use the GET /v1/account/locations/{location_uuid}/documents API.
Get all documents for a location
To retrieve a list of all documents (including historical) related to a specific service location, use the GET /v1/account/locations/{location_uuid}/all-documents API. This includes past documents as well as queued documents that are scheduled to start in the future (for example, a renewal)