EnergyEnrollment schema definitions (v0.2)
12 schema types · Source: deg-main
Main schema for enrollment attributes. Used in: - fulfillmentAttributes (init request): Contains credentials and existingEnrollments - orderAttributes (on_init response): Contains credentialVerification and conflictCheck - orderAttributes (confirm request): Contains startDate and endDate - orderAttributes (on_confirm response): Contains full enrollment details including credential
Represents a W3C Verifiable Credential (https://www.w3.org/TR/vc-data-model-2.0/) used in enrollment flow. This is a wrapper/reference object that contains the credential data (as JWT or JSON-LD), metadata, and URLs. The actual credential follows W3C VC Data Model v2.0 structure. Can be a meter ownership credential, program eligibility credential, DER certification credential, or program enrollment credential.
Details of a credential that has been verified by the BPP. Returned in credentialVerification.verifiedCredentials array.
Details of a conflicting enrollment that prevents the requested enrollment from proceeding. Returned in conflictCheck.conflictingEnrollments array.
User authentication request - sent by BAP to BPP in init/confirm requests. Supports OTP-based or OAuth2/OIDC token-based authentication.
User authentication response - returned by BPP to BAP in on_init/on_confirm responses. Contains verification results and extracted user identity.
OTP authentication request from BAP. - Init request: Send mobile number to initiate OTP - Confirm request: Send mobile + nguid + otp for verification
OTP authentication response from BPP. - On_init response: Returns nguid and message ("OTP sent") - On_confirm response: Returns verification result
OAuth2/OIDC authentication request from BAP. Contains JWT tokens for BPP to validate. BPP extracts claims from token.
OAuth2/OIDC authentication response from BPP. Contains verification results and extracted user identity from token.
Meter details for enrollment in an energy program. Contains meter identifier (UMID) and optional utility information. Used in the meters array within orderAttributes during confirm request. At least one meter must be specified for enrollment to be confirmed.
⚠️ DEPRECATED — Use EnergyProgramEnrollment/v2.0 instead. This schema is preserved for backward compatibility. See deg:EnergyEnrollment owl:equivalentClass deg:EnergyProgramEnrollment in vocab.jsonld. Attribute schema for program enrollment (Fulfillment.fulfillmentAttributes and Contract.orderAttributes). These attributes support the onboarding flow where BPP verifies credentials, checks for conflicts, and issues enrollment credentials. Used in init requests (fulfillmentAttributes) and init/confirm responses (Contract.orderAttributes).