Get Started

Please read through to know how to get started with the API integration.

Note: All screenshots are provided using Insomnia. Also sample curl commands are given.

Flow

After initial discussions with DgVerse, a registration mail will be sent to the root account email. Currently all operations need to be done by this account, future versions will introduce manager users for root account.
After registration, make sure you have a password with you. Email and password will be used for login.
Certificates can be broadly categorized into
- Transferable Certificates: These certificates can be owned and easily transferred between parties, ensuring flexibility and verifiable ownership. Examples include ownership certificates and warranty certificates. This type of certificate allows the holder to pass on their rights and credentials to others.
- Non-transferable Certificates: These certificates are permanently linked to the recipient, ensuring they cannot be transferred or shared. Examples include identity certificates and university degrees. This type of certificate guarantees that the credentials remain exclusively with the individual to whom they were issued.

Main Features

Creating a collection: A collection can consist of multiple fungible or non-fungible tokens (certificates in our case). For example, you might create a collection of “B.Tech Certificates” for a passing out batch of students., where each piece is an individual “Certificate” within the collection.
Directory: The purpose of a directory is to organize or categorize “certificates” within a collection. Think of it as a way to manage and group “Certificates” efficiently. For example, if you have a collection of “B.Tech Computer Science”, the directories will be “2024”, “2025”, “2026”, etc.
Minting a certificate: Minting refers to creating new “Certificates” within an existing collection. When you mint a “Certificate”, you’re adding a new instance of that collection. For example, if you have a Collection of “B.Tech Computer Science”, minting a new collection would create a unique “Certificate” for a student . .
Transfer: Direct and through mail: A direct transfer is straightforward: you send “Certificates” directly from one account to another. You can transfer the certificate by passing the user email of the recipient, provided that user have already registered with DgVerse. But what about someone new to the application? See next line (Claim through mail)
Claim through mail: You can invite a user by giving the email address and the certificate will be available for claiming for next 3 days. Recipient can claim directly from the mail and launching in dgverse. From the application, recipient can share the credentials with LinkedIn too.
Management: Once a collection is created, you various methods to manage the collection.
- Delete collection: This will allow invalidate the entire collection including all the certificates minted. Deleting a collection doesn’t remove it from the ledger entirely; instead, it marks the collection as deleted. The collection information remains accessible for historical purposes, but no further operations can be performed on it.
- Freeze an user: When you freeze an user respective to the collection, it stops all collection operations such as transfer only for a specific user. This can be useful if you need to temporarily prevent any further activity related to a specific collection for a particular user. For example, a student have gone against the rules and are facing ban for 3 years, in cases like we can freeze that user.
- Invalidate certificates from a user: Allows you to delete certificates from a user which was created by you. For example, a student have gone against the rules and are facing ban for lieftime. In case like that the certificate can be invalidated
- Delete Certificates: It allows you to delete certificates that are created by you. Pause: Pausing a collection stops all operations for that collection all user. It’s useful when you want to temporarily halt all activity related to a specific collection.
- Make collection immutable: Once this option is enabled, Once created, you won’t be able to update or delete the collection, however you can mint certificates. You can choose here whether you want to exercise this capability or not