📖
Managed Guardian Service Documentation
HomeSupportContact UsAbout
  • 👋The Next Generation of Registry Systems
  • Overview
    • 🌎Quick Start - MGS
    • 🌐Quick Start - Indexer
      • 🌐Existing MGS Account Users
      • 🌐New User Without an MGS Account
    • ✨Key Features of Managed Guardian Service (MGS)
    • 🤖Custom MGS ChatGPT Assistant
  • LEARN
    • 🎬Important Concepts
      • ☺️Types of Users
      • ⛓️About the Trust Chain
      • 📂About Schemas
      • 🔃About Policies
      • 🎮About Dry Run
      • ⚖️About Retirement
      • 🔐About MGS Vault
    • 📽️Methodology Breakdown
  • 🆕WHAT'S NEW
    • Changelog
      • Beta v1
      • Beta v2
      • Beta v3
      • Beta v3.1
      • Beta v3.2
      • Beta v4
      • Beta v5
      • Beta v5.1
      • Beta v6
      • Beta v7
      • Beta v8
      • Beta v9
      • Beta v10
      • Beta v10.1
      • Beta v10.2
  • TECHNICAL INFORMATION
    • 📯Tenant Admins
      • 🗃️IPFS Storage Providers
        • ☑️Compatible IPFS Storage Providers
        • ☁️Managed IPFS Node
          • 🗃️Integrating Managed IPFS Node with MGS Tenants
        • ☁️Web3.Storage
          • 🔐How to Generate Web3.Storage Key and Proof
          • 🗃️Integrating Web3.Storage with MGS Tenants
        • ☁️filebase
          • 🔐Setting up filebase
          • 🗃️Integrating filebase with MGS Tenants
      • 🛠️Tenant Operations
        • ⚙️Tenant APIs
          • Return Tenants
          • Return user Tenants
          • Create New Tenant
          • Return Tenant Related Settings
          • Send Invite Link
          • Delete Tenant
          • Return Users for Tenant
          • Delete Tenant User
          • Reorder Tenants
      • 🖥️Creating Tenants using the UI
    • 👨‍💻Users
      • 🏫Standard Registry Users, Schemas, and Policies
        • 🛠️Schemas
          • 📂Available Schema Types
          • 📁Property Glossary
          • ℹ️System / Policy Schemas
          • 🖥️Creating a System Schema using the UI
          • 🖥️Creating a Policy Schema using the UI
          • 💻Creating Tag Schemas using UI
          • ⚙️Schema Creation Using APIs
            • Listing of Schema
            • Publishing schema based on schema ID
            • Updating Schema
            • Deleting a Schema
            • Schema Preview from IPFS
            • Schema Preview from Zip
            • Export message IDs of Schema
            • Export Files from Schema
            • Creation of Schema related to the topic
            • Returns all Schemas related to the topic
            • Importing Zip file containing Schema
            • Import schema from Zip
            • Returning Schema by SchemaID
          • ⚙️System Schemas APIs
            • Creates New System Schema
            • Returns Schema by Type
            • Returns Schema by Username
            • Updates the Schema
            • Delete System Schema
            • Publishes the Schema
            • Schema Type
          • ⚙️Schema Related APIs for Asynchronous Execution
            • Creation of Schema
            • Publishing Schema
            • Previews the Schema from IPFS
            • Importing Schema from IPFS
            • Importing Schema from .zip
          • 📁Schema Tree
            • 💻Schema Tree UI
            • ⚙️Returning Schema Tree API
          • 📁Example Data
            • 💻Adding Example data using UI
          • 📁Schema Differentiation
            • 💻Schema Differentiation using UI
            • ⚙️Schema Differentiation APIs
              • Returns Result of Schema comparison
              • Exports Schema Differentiation Results
          • 📁Tag Schema
            • ⚙️Tag Schema APIs
              • Returning all Schema Tags
              • Creating new Schema Tag
              • Deleting Schema Tag
              • Updating Schema Tag
              • Publishing Schema
              • Returning list of published schemas
          • Schema Predefined Values
          • Schema Rules
            • Defining Schema Rules using UI
            • APIs related to Schema Rules
              • Creation of the new schema rule
              • Retrieve the schema rules
              • Retrieve the configuration of the rule by its ID
              • Update the configuration of the rule with the corresponding ID
              • Delete the rule by its ID
              • Activate the rule with the specified ID
              • Deactivate the rule with the specified ID
              • List all the schemas and policy relevant to the rule with the specified ID
              • Retrieve all the data needed for evaluating the rules
              • Create a new rule from the file
              • Load the file and return its preview
              • Export the selected rule (by ID) into the file
        • 🛠️Policies
          • 🎓Policy Glossary
          • 🔄Available Policy Workflow Blocks
            • InterfaceContainerBlock
            • PolicyRolesBlock
            • InterfaceStepBlock
            • requestVCDocumentBlock
            • sendToGuardianBlock
            • reassigningBlock
            • InformationBlock
            • InterfaceDocumentsSourceBlock
            • paginationAddon
            • DocumentsSourceAddOn
            • filtersAddOnBlock
            • InterfaceActionBlock
            • externalDataBlock
            • retirementDocumentBlock
            • wipeDocumentBlock
            • calculateMathAddOnBlock
            • reportBlock & reportItemBlock
            • switchBlock
            • TimerBlock
            • aggregateDocumentBlock
            • revocationBlock
            • setRelationshipsBlock
            • Button Block
            • documentValidatorBlock
            • tokenActionBlock
            • tokenConfirmationBlock
            • mintDocumentBlock
            • groupManagerBlock
            • multiSignBlock
            • customLogicBlock
            • splitBlock
            • create Token Block
            • Impact Addon
            • Http Request Block
            • historyAddOn
            • selectiveAttributes Block
            • tagsManagerBlock
            • extractDataBlock
            • externalTopicBlock
            • messagesReportBlock
            • notificationBlock
            • Button BlockOn Addon
            • Data Transformation Addon
            • Events
          • 💻Creating Policy using UI
          • 🖥️Creating a Policy using Policy Configurator
            • Getting Started with the Policy Workflows
            • Policy Workflow Step 1
            • Policy Workflow Step 2
            • Policy Workflow Step 3
            • Policy Workflow Step 4
            • Policy Workflow Step 5
            • Policy Workflow Step 6
            • Policy Workflow Step 7
            • Policy Workflow Step 8
            • Policy Workflow Step 9
            • Policy Workflow Step 10
            • Policy Workflow Step 11
            • Policy Workflow Step 12
            • Policy Workflow Step 13
            • Policy Workflow Step 14
            • Policy Workflow Step 15
            • Policy Workflow Step 16
            • Policy Workflow Step 17
            • Policy Workflow Step 18
            • Policy Workflow Step 19
            • Policy Workflow Step 20
            • Policy Workflow Step 21
            • Policy Workflow Step 22
            • Policy Workflow Step 23
            • Policy Workflow Step 24
            • Policy Workflow Step 25
            • Policy Workflow Wrap Up
          • ⚙️Creating a Policy using APIs
            • Prerequesite Steps
            • Creation of a Policy
            • Policy Listing
            • Policy from IPFS
            • Policy Preview from IPFS
            • Retrieves Policy Configuration
            • Updates Policy Configuration
            • Publish a Policy
            • Policy Validation
            • Retrieval of Data from Root Policy Block
            • Request Block Data
            • Sends Data to Specified Block
            • Sends Data to specified Block by Tag
            • Returns Block ID by tag
            • Retrieves Block Data by Tag
            • Exporting Message ID
            • Export to zip file
            • Import from zip file
            • Returns list of Groups of a particular user
            • Make the selected Group active
            • Creating link between policies
            • Requesting Multi Policy Config
            • Imports open sourced policy
            • Allowed open sources list for import
            • Returns Open Source File URL
            • Returns OpenSourced policies list for import
          • 📂Dry Run
            • 🖥️Dry Run Mode using the UI
              • Dry Run Operations Guide
            • ⚙️Dry Run Mode using APIs
              • Running Policy without making any changes
              • Returning all Virtual Users
              • Creating Virtual Account
              • Logging Virtual User
              • Restarting the execution of Policy
              • Returns List of Transactions
              • Returns List of Artifacts
              • Returns List of IPFS Files
              • Returning Policy to Editing
              • Create Savepoint
              • Returns Savepoint State
              • Restoring SavePoint
              • Deletes SavePoint
          • 📁Record/Replay
            • 💻Policy execution record and replay using UI
            • ⚙️Record/Replay APIs
              • Get Recording
              • Start Recording
              • Stop Recording
              • Get Recorded Actions
              • Run record from zip file
              • Stop Running
              • Get Running Results
              • Fast Forward
              • Retry Step
              • Skip Step
          • 🪟External Events
            • ⚙️Send Data using the External Data APIs
              • Sends Data from External Source
          • ⚙️Trustchain APIs
            • Requesting
            • Building and returning
          • ⚙️Policy Related APIs for Asynchronous Execution
            • Creates new Policy
            • Publishing a Policy
            • Importing a Policy from IPFS
            • Importing a Policy from File
            • Policy Review
          • 🧑‍🤝‍🧑Roles and Groups
            • 💻Creating Roles and Groups using Policy Configurator UI
          • 📂Modules
            • 💻Modules using UI
            • ⚙️Modules APIs
              • Returns all Modules
              • Creating new Module
              • Returns Module Menu
              • Retrieves Module Configuration
              • Updates Module Configuration
              • Delete the module
              • Publishing Module onto IPFS
              • Returns Hedera ID for specific Module
              • Exporting Module in zip format
              • Import Module from IPFS
              • Import module from zip file
              • Preview Module from IPFS
              • Preview Module from zip file
              • Validates Module
          • 📂Tools
            • 💻Tools using UI
            • ⚙️Tools APIs
              • Creating new Tool
              • Returns list of tools
              • Creating new tool asynchronously
              • Deletes the tool
              • Retrieves Tool Configuration
              • Updates Tool Configuration
              • Publishes Tool onto IPFS
              • Publishes Tool into IPFS asynchronously
              • Validates Selected Tool
              • Returns Tools and its artifacts in zip format
              • Retrieves Hedera Message ID
              • Previews Imported Tool from IPFS
              • Imported Tool from IPFS
              • Previews Imported Tool from Zip
              • Importing Tool from Zip
              • Imports new tool from Zip Asynchronously
              • Imports new tool from IPFS Asynchronously
              • Returns List of Tools
          • 🔑Selective Disclosure
            • 📔User Guide
            • 💻Selective Disclosure Demo
          • 📂Policy Differentiation
            • 💻Global search and comparison UI
            • 💻Policy Differentiation using UI
            • ⚙️Policy Differentiation APIs
              • Comparing Policies
              • Searching Policies
              • Exports Comparison results
          • 📂Block/Policy Search
            • 💻Block Search using UI
            • ⚙️Block Search APIs
              • Searching Same Blocks
            • 💻Policy Search using UI
            • ⚙️Policy Search APIs
              • Search Policies
          • 📂Document Comparison
            • 💻Document Comparison using UI
            • ⚙️Document Comparison APIs
              • Compare Documents
              • Export of Comparison Result
          • 📂Tagging
            • 💻Tagging using UI
            • ⚙️Tagging APIs
              • Creating Tag
              • Searching Tag
              • Deleting Tag
              • Synchronization of Tags
          • 🤖Auto Suggestion
            • 💻Demo using UI
            • ⚙️Auto Suggestion APIs
              • Get next and nested suggested block types
              • Get suggestions configuration
              • Set suggestions configuration
          • 📂Themes
            • 💻Themes using UI
            • ⚙️Themes APIs
              • Returning all themes
              • Creating theme
              • Updating theme Configuration
              • Deleting theme
              • Returning zip file containing themes
              • Importing theme
          • 📂Policy Wizard
            • 💻Demo using UI
            • ⚙️Policy Wizard APIs
              • Creating new Policy
              • Getting Policy Configuration
          • 📁Discontinuing Policy
            • 💻User Guide
            • ⚙️APIs related to Discontinuing Policy
              • Discontinue Policy
              • Migrate Policy Data
              • Migrate Policy Data Asynchronously
              • Get Policy Documents
          • 📁Live Project Data Migration
            • ➡️Live Project Data Migration UI
            • ⚙️APIs related to Live Project Data Migration
              • Getting Policy Data
              • Uploading Policy Data
              • Getting Policy Tag Block Map
              • Getting Policy Virtual Keys
              • Uploading Policy Virtual Keys
          • Roles & Permissions
            • Roles and Permissions User Guide
            • APIs related to Roles & Permissions
              • Returns list of all permissions
              • Returns list of all roles
              • Creates a New Role
              • Updates Role Configuration
              • Deletes Role
              • Setting Default Role
              • Returns list of all users for whom the current user can change the role
              • Retrieves information about the user (roles, permissions assigned policies)
              • Updates User Roles (only SR)
              • Returns list of all Policies
              • Assigns Policies to a User - Only SR
              • Updates user roles (for ordinary users)
              • Assigns policies to a user (for ordinary users)
          • 📁Import/Export from Excel
            • 💻Import and Export Excel file User Guide
            • ⚙️APIs related to Import/Export Schemas from Excel
              • Import Schemas in Excel file format into local DB
              • Asynchronously Imports Schemas in Excel file format into a policy
              • Previews Schema from Excel file
              • Returns Schema in Excel file format
              • Returns list of Schemas
              • Exporting Policy to Excel
              • Import Schemas in Excel file format into a Policy
              • Policy Preview from Excel file
          • 💻Demo on Integrating external policies using UI
          • 📁Policy Labels
            • Policy Labels UI
            • APIs related to Policy Labels
              • Creating new Label definition
              • Retrieve the list of Label definitions
              • Retrieve a label definition configuration by ID
              • Update Label configuration by ID
              • Delete Label definition by ID
              • Publish Label definition by ID
              • Publish Label definition by ID asynchronously
              • Retrieve the list of components for Label configuration (schemas, policies, etc)
              • Import Label configuration from a file
              • Export Label configuration to a file
              • Preview of the imported file
              • Search for Labels and Statistics for importing into Label configuration
              • Retrieve the list of created tokens (VPs) for which a Label document can be created
              • Retrieve token (VP) and all its dependencies by document ID
              • Create a new Label document for token (VP)
              • Retrieve a list of created Label documents
              • Retrieve Label document by ID
              • Retrieve linked Label documents by ID
          • Formula Linked Definitions
            • Formula Linked Definitions using UI
            • APIs related to Formula Linked
              • Creating a new formula
              • Returns a list of formulas
              • Returns a formula by its ID
              • Update the formula by its ID
              • Delete the formula by its ID
              • Retrieve the list of all schemas and policies linked to a Formula
              • Create a new formula (import) from a file
              • Export selected formulas into a file
              • Loads (import) a file and return its preview
              • Publish a formula
              • Retrieve all data from documents that needed for displaying the formula
          • Decentralized Guardian
            • Remote Policy UI
            • ⚙️APIs
              • Returns the list of requests for adding remote policies
              • Previews the policy from IPFS without loading it into the local DB
              • Policy Import from IPFS
              • Approves policy Asynchronously
              • Rejects policy Asynchronously
              • Approves Policy
              • Rejects policy
              • Return a list of all policies requests
              • Approves a request for an action from a remote Guardian
              • Rejects a request for an action from a remote Guardian
              • Return a count of policy requests
          • 📔Artifacts
            • 💻Importing/Deleting Artifacts using UI
            • ⚙️Artifacts APIs
              • Returns all Artifacts
              • Upload Artifacts
              • Delete Artifact
          • 🔔Notifications
            • 💻User Guide
            • ⚙️APIs related to Notifications
              • Get all Notifications
              • Get new Notifications
              • Get Progresses
              • Read All Notifications
              • Delete Notifications
        • 🛠️Standard Registry Operations
          • ⚙️Task Status APIs
            • Returning Task Statuses
      • 🛠️User Operations
        • ✖️Multi Policy
          • 💻Configuring Multi Policy using UI
        • 🤖AI Search of Methodologies
          • 💻AI Search using UI
          • ⚙️AI Search APIs
            • Returns response
            • Rebuilds vector based on policy data
        • 🔎Guided Search of Methodologies
          • 💻Search using UI
          • ⚙️Search APIs
            • Retrieves list of all categories
            • List of policies that are best suited for given parameters
        • ⚙️Account APIs
          • Display User List
          • User Balance
          • User Session
          • User Login
          • Registering new account
          • Returns all Standard Registries
          • Requests Password Reset
          • Sets New Password
          • Current version terms of use
          • Accept terms of use
          • Returns all Standard Registries with Policies and VC Documents
        • ⚙️Profile APIs
          • User Account Balance
          • User Account Information
          • Setting User Credentials
          • Setting User Credentials Asynchronously
          • Setup Vault for user secrets
        • ⚙️Artifacts APIs
          • Returns all Artifacts
          • Upload Artifacts
          • Delete Artifacts
        • Bottom Up Data Traceability
          • Bottom Up Data Traceability using UI
          • APIs related to Statistics Report
            • Create new Statistics Definition
            • Get the list of Statistics Definitions
            • Retrieve details of the Statistics Definition by ID
            • Update configuration of the Statistics Definition by ID
            • Delete the Statistics Definition by ID
            • Publish Statistics Definition by ID
            • Retrieve the list of linked schemas and policy
            • Retrieve the list of all documents conforming the rules of the Statistics Definition
            • Create a new Statistics Assessment based on the Statistics Definition
            • Retrieve the list of existing Statistics Assessment
            • Retrieve the Statistics Assessment by ID
            • Retrieve all VC documents related to the Statistics Assessment
            • Importing Statistic from zip file
            • Exporting statistic report to a file
            • Previews the statistic report imported from zip file
      • 📁Bring your own DIDs
        • 💻Bring Your Own (BYO) DIDs UI
        • ⚙️BYO APIs
          • Validate DID Format
          • Validate DID Keys
      • Asynchronous Tasks Status
      • Show list of Hedera Transactions
        • Showing List of Hedera Transactions UI
        • APIs
          • Returning all transactions for Policy
          • Returning all transactions for Schema
          • Returning all transactions for Contract
          • Returning all transactions for Tokens
      • 🔐MGS Vault
        • ☑️Compatible Vaults
        • 🔑MGS Vault
          • 🎙️Introducing MGS Vault
          • ⚙️HashiCorp Vault Setup
          • ⚙️HashiCorp Vault Integration with MGS
        • 🔑Microsoft Azure Key Vault
          • 🎙️Introducing Microsoft Azure Key Vault
          • ⚙️Microsoft Azure Key Vault Setup
          • ⚙️Microsoft Azure Key Vault Integration with MGS
        • 🔑Google Cloud Platform Secret Manager
          • 🎙️Introducing Google Cloud Platform Secret Manager
            • ⚙️GCP Secret Manager Setup
            • ⚙️GCP Secret Manager Integration with MGS
    • 🕐Obsolete Guardian Artifacts
    • 📁Project Comparison
      • ⚙️Project Comparison APIs
        • Comparing Documents
        • Retrieves all categories
        • Retrieves all Properties
        • Search Projects by filters
    • Global Indexer
      • Indexer User Guide
      • APIs related to Indexer
        • Full Text Indexer Search
        • Returns Standard Registries
        • Returns Registry as per MessageID
        • Returns Registry Users
        • Returns Registry User as per MessageID
        • Returns Policies
        • Returns policy as per MessageID
        • Returns Tools
        • Returns Tool as per MessageID
        • Returns Modules
        • Returns Module as per MessageID
        • Returns Schemas
        • Returns Schema as per MessageID
        • Returns Schema Tree
        • Returns Tokens
        • Returns Token as per TokenID
        • Returns Roles
        • Returns Role as per MessageID
        • Returns DIDs
        • Returns DID as per MessageID
        • Returns DID Relationships
        • Returns VP Documents
        • Returns VP Document as per MessageID
        • Returns VP Relationships
        • Returns VC Documents
        • Returns VC Document as per MessageID
        • Returns VC Relationships
        • Returns NFTs
        • Returns NFT as per Serial No.
        • Returns Topics
        • Returns Topic as per TopicID
        • Returns Contracts
        • Returns Contract as per MessageID
        • Returns Landing Page Analytics
        • Returns Project Coordinates
        • Returns Search Policy Results
        • Attempts to refresh linked files for the selected documents
        • Returns Hedera Network
        • Returns Hedera Network Explorer Settings
        • Returns Data Loading Progress Result
        • Returns Registry Relationships
        • Returns Policy Relationships
        • Retrieve the list of formulas
        • Retrieve the formula by message ID
        • Retrieve linked documents which are related to formula
        • Returning Topic Data Priority Loading Progress
        • Adding Topic Data Priority Loading
        • Adding Policy Data for Priority Loading
        • Adding Token Data for Priority Loading
        • Adding Document to Data Priority Loading
    • ⚙️API Guideline
    • 🪙Tokens
      • 💻Creating Token using UI
      • 📁Token Template
        • 💻Creating Token Template using UI
        • 💻Creating Token through UI using Token Template
      • 🔎How to establish Token Authenticity
      • 🛠️Token Operations
        • ⚙️Token APIs
          • Token Listing
          • Creation of the token
          • User Info for selected token
          • Associates the user with token
          • Disassociates the user with token
          • Grants KYC for the user (Deprecated)
          • Grants KYC for the user
          • Revoke KYC of the user (Deprecated)
          • Revoke KYC of the user
          • Freeze tokens of a user
          • Unfreeze tokens of a user
      • 📁Token Retirement Contract
        • 💻Creating Contract using UI
        • TrustChain representation of token retirement
        • ⚙️Retirement APIs
          • Returning all contracts
          • Creating new Contract
          • Importing new Contract
          • Get Contract Permissions
          • Removing Contract
          • Returns a list of all Wipe requests
          • Enabling Wipe Requests
          • Disabling Wipe Requests
          • Approving Wipe Requests
          • Rejecting Wipe Requests
          • Clearing Wipe Requests
          • Adding Wipe Admin
          • Removing Wipe Admin
          • Adding Wipe Manager
          • Removing Wipe Manager
          • Adding Wipe Wiper
          • Removing Wipe Wiper
          • Syncing Retire Pools
          • Returning list of all Retire Requests
          • Returning list of all Retire Pools
          • Deleting Retire Requests
          • Deleting Retire Pools
          • Setting Retire Pools
          • Unsetting Retire Pool
          • Unsetting Retire Request
          • Retiring Tokens
          • Approving Retire Request
          • Cancelling Retire Request
          • Adding Retire Admin
          • Removing Retire Admin
          • Returning all Retired VCs
      • Dynamic Token Creation in Guardian Policies
    • ⛓️Trust Chain
      • 🛠️Trust Chain Operations
        • ⚙️Trust Chain APIs
          • Requesting
          • Building and Returning
    • 🔬Open-Source Guardian Architecture
      • 🔭High Level Architecture
      • 🔬Deep Dive Architecture
      • 👏Policies,Projects and Topics mapping Architecture
      • ➗MRV Splitting Logic
      • 🔑Internal (with Vault)Signing Sequence Diagram
      • 🔥FireBlocks Signing Sequence Diagram
    • 📄Full API Documentation
    • 📁Library of Policy Examples
      • 💻Creating and using Roles
      • 🔢Data input via Forms, using Roles to partition user activities
      • 🪙Token Operations
      • 📃MRV Document Operations
      • ⛓️TrustChain reports
      • ➗MRV aggregation and splitting for minting tokens
    • 🔁Process for Testnet Resets
      • Deleting Tenants and Re-inviting Users
      • Setup of a User Account
  • 🗺️Preloaded Policy Guides
    • 🌳Carbon Offsets
      • 🌲Verra Redd+ VM0007 Policy Guide
      • 👩‍🌾VM0017 Adoption of Sustainable Agricultural Land Management, v1.0
      • 👩‍🌾VM0042 Methodology for Improved Agricultural Land Management
      • 🌲VM0047 Afforestation, Reforestation, and Revegetation
      • 🌲Gold Standard Afforestation and Reforestation (AR) v2.0
      • 👷Carbon Reduction Measurement - GHG Corporate Standard Policy Guide
      • 👩‍🌾Dovu Methodologies (Agre Calc & Cool Farm)
      • 🚗Sustainable End-of-Life Vehicle Scrapping Program: Government Backed Voluntary Program
      • ♨️Improved Cookstove
      • ♨️GoldStandard - Metered Energy Cooking
      • 🏭CDM AMS-II.G.: Energy Efficiency Measures in Thermal Applications of Non-Renewable Biomass
      • 🏭CDM AMS-III.AR: Substituting fossil fuel based lighting with LED/CFL lighting systems
      • 🏭CDM AMS-III.D.: Methane Recovery in Animal Manure Management Systems
      • 🏭CDM AMS III.BB: Electrification of communities through grid extension
      • 🏭CDM AR-ACM0003: Methodology for Afforestation and Reforestation of Lands Except Wetlands
      • 🏭CDM ACM0001: Flaring or Use of Landfill Gas
      • 🏨CDM ACM0002: Grid-Connected Electricity Generation from Renewable Sources
      • 🏭CDM ACM0006: Electricity and Heat Generation from Biomass
      • 🏭CDM ACM0007: Conversion from Single Cycle to Combined Cycle Power Generation
      • 🏭CDM ACM0018: Electricity Generation from Biomass in Power-Only Plants
      • 🏨CDM AMS-I.A.: Electricity Generation by the User
      • 🏨CDM AMS-I.C.: Thermal Energy Production with or Without Electricity
      • 🏨CDM AMS-I.F.: Renewable Electricity Generation for Captive Use and Mini-Grid
      • 🏛️CDM AMS-II.J.: Demand-Side Activities for Efficient Lighting Technologies
      • 🏭CDM AMS-III.AV.: Low Greenhouse Gas Emitting Safe Drinking Water Production Systems
      • 🏭CDM AMS-III.F.: Avoidance of Methane Emissions Through Composting
      • 🏦CDM AMS-III.H.: Methane Recovery in Wastewater Treatment
      • 🏭PWRM0001 Plastic Waste Collection Methodology
      • 🥇Carbon Sequestration through Accelerated Carbonation of Concrete Aggregate
      • 🏭VM0044 Methodology for Biochar Utilization in Soil and Non-Soil Applications
      • 🏭VM0041 Methodology for the Reduction of Enteric Methane Emissions from Ruminants
      • 🏭AMS-I.D: Grid Connected Renewable Electricity Generation – v.18.0
      • 🏭PWRM0002 Plastic Waste Recycling Methodology
      • 🍚Methane Emission Reduction by Adjusted Water Management Practice in Rice Cultivation
      • ⛽Verra VMR0006: Energy Efficiency and Fuel Switch Measures in Thermal Applications
      • AMS-I.E Switch from Non-Renewable Biomass for Thermal Applications by the User
      • GCCM001 v.4 Methodology for Renewable Energy Generation Projects Supplying Electricity to Grid
      • Climate Action Reserve’s U.S. Landfill Protocol Version 6.0
      • Landfill Gas Destruction and Beneficial Use Projects, Version 2.0
      • VM0042 Improved Agricultural Land Management, v2.1
    • 🔋Renewable Energy Credits
      • 📡International Renewable Energy Credit Standard Policy guide
    • 🏭Carbon Emissions
      • 🏠Remote Work GHG Policy Policy Guide
      • 🏢Carbon Emissions Measurement - GHG Corporate Standard Policy Guide
      • 🏙️atma GHG Scope II Carbon Emission Policy
      • 🏢Atma Scope 3 GHG Policy
      • 🏢GHGP Corporate Standard
      • 🏭GHGP Corporate Standard V2
Powered by GitBook
On this page
  • Methodologies
  • Scope 3 data
  • Policy Guide
  • Project Owner
  • Installer
  • Sending MRV
  • Add MRV using guardian UI
  • Verification
Export as PDF
  1. Preloaded Policy Guides
  2. Carbon Emissions

Carbon Emissions Measurement - GHG Corporate Standard Policy Guide

Policy developed by TYMLEZ

PreviousRemote Work GHG Policy Policy GuideNextatma GHG Scope II Carbon Emission Policy

Last updated 2 years ago

On this page you'll find:

For more Carbon Emissions Measurement - GHG Corporate Standard information, please visit the TYMLEZ-contributed open-source Guardian policy page

Methodologies

TYMLEZ aims to provide the capability to quantify and tokenize carbon. To do this, we have designed a universal schema that can be used as the basis for both insetting and avoidance claims made against any GHG Protocol compatible project. Whilst these schemas will not be able to be used verbatim for all carbon registries, they form an important base for digital measurement, reporting, and verification (dMRV) recording against a particular project. A core focus at TYMLEZ is the accurate reading of MRV data from source devices. As such, this schema is not designed for use in scenarios requiring the manual entry of carbon data – we have however included UI screens to support manual entry in this public version.

We have included a full schema for the CET policy that can be used to record Scope 1 & 2 emissions data

Scope 3 data

TYMLEZ supports the inclusion of Scope 3 emissions data, however, this is not currently included in the provided schema. We instead integrate with partners to support the inclusion of Scope 3 data as external carbon data which fits the dMRV model more than the usual form-based process.

Policy Guide

Typically, the way we start the demonstration is by logging in as a Standard Registry. For this demo guide, we will create a user named "Standard Registry."

You'll now be prompted to configure your Standard Registry account. Enter the details and then press the Generate button to generate a Hedera Operator ID and an Operator Key and enter the name of your Standard Registry. Press Connect when finished. This will now create Hedera Consensus Service Topics, fill the account with test hBar, create a DID document, create a Verifiable Credential, etc.

Once it is selected, we can also preview the policy before importing it. After the policy is imported, we can either run the policy in Dry run mode or we can publish it by clicking on publish button from the dropdown. For testing purposes, we will publish the policy.

Open the policy operations by clicking the "Go" button and add the new site information (the policy does not require a project so leave ProjectId as empty)

Project Owner

Register another new user called the "Project Owner" if it doesn't exist yet.

Select the corresponding standard registry for the new Project Owner.

Login as the new owner user

Associate owner with CET (Click on tokens from the nav link and click on the associate button on the table, see picture below)

Open policy Tymlez CET and fill in the owner information when the screen has loaded and select role as TOKEN_OWNER

After confirming the roles, enter the Project Owner information in the dialog.

Installer

Register a new user called an "Installer" and select the corresponding Standard Registry.

Login as the new Installer and finish the setup steps.

Associate owner with CET (Click on tokens from the nav link and click on the associating button on the table, see picture below).

Open the policy and fill in the installer information when the screen loads.

Select role as INSTALLER.

After confirming the roles, enter the owner information in the dialog

Download the device config from the list.

The installer can add a new device (meter, sensor, IoT... from devices tabs)

Click on New Sensor and fill in information for the device. Note that the site-ID is the DID of the Site that was created in the StandardRegistry step earlier in the workflow.

After this step, log in as the StandardRegistry and go to the Sites tab. You can associate the Site to other Sites or check if it is not entered correctly.

Sending MRV

MRV will be injected using external data source API with the below JSON structure

{
    "owner": "DID of installer or devices",
    "policyTag": "The policy tag",
     "document": {} 
}

document: is the full VC document, please refer to (https://github.com/hashgraph/guardian/blob/main/mrv-sender/src/index.ts#L89). The final payload will look like the below:

    {
    "owner": "DID",
    "policyTag": "Tag_1666330134735",
    "document": {
        "id": "{{$guid}}",
        "type": [
            "VerifiableCredential"
        ],
        "issuer": "DID",       
         "issuanceDate": "2022-10-22T11:12:43.017Z",
        "@context": [
            "https://www.w3.org/2018/credentials/v1"
        ],
        "credentialSubject": [
            {
                "type": "a305f206-4107-47a6-87fb-571ef7655527&1.0.0",
                "@context": [
                    "https://ipfs.io/ipfs/bafkreiarrpieuodeamv4ix75iv4bxp3d6drzdknqaaagwp3x7g2bm73zmy"
                ],
                "readingId": "{{$guid}}",
                "deviceId": "deviceDID",
                "readingDate": "2022-10-22",
                "intervalStartDateTime": "2022-10-22T11:00:00.000Z",
                "intervalEndDateTime": "2022-10-22T11:05:00.000Z",
                "intervalDuration": 300,
                "intervalDurationUOM": "s",
                "value": 0.5,
                "valueUOM": "litre",
                "greenhouseGasEmissionsScope": "Scope 1",
                "greenhouseGasEmissionsSource": "DIRECT - STATIONARY COMBUSTION",
                "CO2Emissions": 0.5,
                "CO2eqEmissions": 0.1,
                "CO2eqEmissionsTYMLEZ": 0,
                "emissionsUOM": "t",
                "CO2eqFormula": "$value * 2.70972",
                "tokenOwnerId": "0.0.48700521"
            }
        ],
         "proof" : {
            "type" : "Ed25519Signature2018",
            "created" : "2022-10-21T05:40:13Z",
            "verificationMethod" : "did:hedera:testnet:VX3a6nYMtoaKEvcvqamjeknqb2MSYMd7GHP8RB13bCn;hedera:testnet:tid=0.0.48673640#did-root-key",
            "proofPurpose" : "assertionMethod",
            "jws" : "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..0PjYVmLHl_pL5IYd6XnNv5aSvSduVBaNX7VhWbfNpfdkAtSTKuKsjjBs0CuC3i8l1XIMyRHdm3yn3N4jRS3IAQ"
        }
    }
}

Add MRV using guardian UI

The policy was designed with the policy block that allows Token Owner can manually add MRV from guardian UI, we suggest using this for testing purpose only, the real-time data need to be injected via the API method above

Login as Token Owner

Open the policy

Open MRV tabs

Click on Add MRV and fill up all the values for your MRV

Submit MRV then the new MRV will display in the list, Aggregation will run in the background and respect the token mint rule same with realtime data ingression.

Note:

  • OwnerAccountId: needs to be set to the Hedera Account ID of the Token Owner user. This value can be copied from the profile page

  • DeviceID: should be set to Device DID

Verification

After sending MRV using the above API call you can log in as the Standard Registry or Token Owner to view the VP in the Trustchain block.

VP data looks like this:

Trustchain viewer looks like this:

Now we will be creating the Policy. We have three ways to "create policies." The first way is to actually create the policy from scratch. The second way is to import an existing policy; either the policy file itself or from IPFS. When you import a policy, all schemas and tokens that are required in the policy are automatically populated. To do this, you can find the policy file and the IPFS timestamp on the open-source Guardian policy page . For this demo guide, we will be using the 3rd way to create a policy, which is through the preloaded drop-down list.

🗺️
🏭
🏢
here
here
here
Policy Description
Workflow Description
Policy Guide
For Organizations to create an Employer User (Employer Admin User)
For Employees to create an Employee User and join an organization