Identity handling in Environmental Credit Service (preview)
Microsoft Cloud for Sustainability - Free trial
Important
Some or all of this functionality is available as part of a preview release. The content and the functionality are subject to change. You can access the Environmental Credit Service (preview) sandbox environment for a 30-day trial. To use Environmental Credit Service (preview) in a production environment, complete the Environmental Credit Service (preview) sign up form.
You can pass the identity provided by the identity provider while submitting a proposal to the identity provider with Environmental Credit Service. The identity provider can receive the identity information of the organization as part of the submitted proposal and use it for identifying the organization on their platform
Currently this capability is enabled only via APIs for the following workflows:
- Modular benefit project registration (MBPRegister proposal)
- Ecological claim verification (MBPClaimVerify proposal)
- Credit issuance (CreditMint proposal)
- Trader registration (MarketplaceTraderRegister proposal)
- Listing (MarketplaceListingRegister proposal)
- De-listing (MarketplaceListingDeregister proposal)
- Listing transfer (MarketplaceListingTransfer proposal)
- Credit retirement (CreditRetire, ESGEmissionOffset proposals)
For these workflows, the organization submitting the proposal can pass their identity on the identity provider platform (issuing registry, marketplace, validation and verification body) by passing the following details in the externalIds section of the proposal API request:
Id: specify the identity of the organization on the identity provider platform in this attribute, according to the following table.
Proposal Identity provider for the proposal MBPRegister CreditMint CreditRetire ESGEmissionOffset Issuing registry MBPClaimVerify Validation and verification body MarketplaceTraderRegister MarketplaceListingRegister MarketplaceListingDeregister MarketplaceListingTransfer Marketplace On block:
- MarketRole: Specify the identity provider organization’s Environmental Credit Service market role.
- OrganizationId: Specify the identity provider organization’s Environmental Credit Service organization ID.
Of block:
- MarketRole: Specify the market role of the organization submitting this request.
- OrganizationId: Specify the organization ID of the organization that is submitting this request.
If a buyer organization is submitting the retirement request on behalf of the end use buyer who has the registry account, the buyer organization needs to specify the end use buyer’s identity on the identity provider's platform (issuing registry) so that the identity provider can identify the end use buyer. Pass the following details in the externalIds section of the end use buyer section of the proposal API request:
Id: specify the identity of the end use buyer on the identity provider platform in this attribute.
On block:
- MarketRole: Specify the identity provider organization’s Environmental Credit Service market role.
- OrganizationId: Specify the identity provider organization’s Environmental Credit Service organization ID.
The proposal approver can view the identity shared as part of the proposal API response.
If the identity shared is incorrect, the proposal approver can send the proposal back to the submitter for edits along with a relevant message.
POST/proposals/{proposal_id}/action
For action, specify ReturnForEdits.
The submitter can view the comment, update the identity information in the proposal API, and then resubmit the proposal to the approver for review.
API for updating the identity information in the proposal:
PATCH/proposals/{proposal_id}
API to resubmit the proposal:
POST/proposals/{proposal_id}/action
For action, specify Resubmit.
The approver can review the updated proposal and decide to approve or reject it.
See also
Environmental Credit Service (preview) overview Environmental Credit Service (preview) glossary Configure Environmental Credit Service (preview) API reference overview for Environmental Credit Service (preview)
