From cc775935e5fdb15034c43595ed268a6b6a4e0518 Mon Sep 17 00:00:00 2001 From: m4sterbunny <20266893+m4sterbunny@users.noreply.github.com> Date: Wed, 27 Nov 2024 11:46:14 +0000 Subject: [PATCH 1/7] fixes: proof items and structural improvements --- docs/quick-start-demo.md | 118 +++++++++++++++++++++++++-------------- 1 file changed, 77 insertions(+), 41 deletions(-) diff --git a/docs/quick-start-demo.md b/docs/quick-start-demo.md index f43491b9..943fa688 100644 --- a/docs/quick-start-demo.md +++ b/docs/quick-start-demo.md @@ -15,98 +15,133 @@ keywords: --- import useBaseUrl from '@docusaurus/useBaseUrl'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; This tutorial is a quick demonstration of some of Privado ID's main functionalities. To illustrate how Privado ID works, we will walk you through some of its products and tools by following along a simple POAP use case. POAP stands for Proof of Attendance Protocol, which is used to prove that someone has taken part in a given event. -This guide will briefly touch on the 3 roles of the [Triangle of Trust](introduction.md#core-concepts-of-privado-id-verifiable-credentials-identity-holder-issuer-and-verifier), namely the Identity Holder, the Issuer and the Verifier. For that, we will take the case of an individual who needs to prove that they were able to participate in a particular event. +This guide will briefly touch on the 3 roles of the [Triangle of Trust](introduction.md#core-concepts-of-privado-id-verifiable-credentials-identity-holder-issuer-and-verifier), namely the Identity Holder, the Issuer, and the Verifier. For that, we will take the case of an individual who needs to prove that they were able to participate in a particular event. -These are the steps we will cover in this article: +In this tutorial, you will: 1. [Set up a Privado ID wallet](#set-up-a-privado-id-wallet) -2. [Issue a new credential to attest to the ID Holder's attendance to the event](#issue-a-new-credential-to-attest-to-the-id-holders-event-attendance) +2. [Issue a new credential to attest to the ID Holder's attendance to the event](#issue-the-poap-credential) 3. [Fetch the newly created credential](#fetch-the-newly-created-credential) 4. [Verify the ID holder credential](#verify-the-id-holder-credential) ## Set up a Privado ID wallet To store verifiable credentials, the Identity Holder (the individual receiving the credential) needs a compatible wallet. Here, we’ll use the Privado ID Wallet, which supports both mobile and web-based access. + :::note -You can also use any Privado ID compatible wallet. Please, check our [Ecosystem page](https://marketplace.privado.id/ecosystem) for other options. +You may use any Privado ID compatible wallet. See our [Ecosystem page](https://marketplace.privado.id/ecosystem) for other options. ::: -To get started with the Privado ID Wallet, you can either visit the [Privado ID Web Wallet](https://wallet.privado.id/) in your browser or download the mobile app and create an Identity. +To get started with the Privado ID Wallet, you either visit the [Privado ID Web Wallet](https://wallet.privado.id/) in your browser or download the Mobile App and create an Identity. + -- Web Browser: Privado ID Web Wallet -- For Android: Privado ID Wallet App on Google Play -- For iOS: Privado ID Wallet App on the App Store + + +Privado ID Web Wallet :::note -- The Privado ID Web Wallet is a web based identity wallet. It is a reference implementation built using our [JS SDK](/docs/js-sdk/js-sdk-overview.md). Learn more about the Web Wallet [here](/docs/wallet/web-wallet.md). -- Privado ID Wallet App is an implementation of the [Wallet SDK](/docs/category/wallet-sdk), as a way of showcasing its possibilities. Learn more about the Wallet App [here](/docs/wallet/wallet-app/privadoid-app.md). +The Privado ID Web Wallet is a web-based identity wallet. It is a reference implementation built using our [JS SDK](/docs/js-sdk/js-sdk-overview.md). [Learn more about the Web Wallet](/docs/wallet/web-wallet.md). ::: -## Issue a new credential to attest to the ID Holder's event attendance + + + + +- Android: Privado ID Wallet App on Google Play +- iOS: Privado ID Wallet App on the App Store + +:::note +Privado ID Wallet App is an implementation of the [Wallet SDK](/docs/category/wallet-sdk), as a way of showcasing its possibilities. [Learn more about the Wallet App](/docs/wallet/wallet-app/privadoid-app.md). +::: -A trusted entity, for instance, a private institution will now play the role of an issuer. It will be responsible for creating the credential and sending it to the ID Holder. + + -We are using the Issuer Node UI Demo environment to manage credentials. This is the place where you as an issuer can can create and manage identities and credentials, generate connections and manage schemas. -However, if you are using a new credential type, you actually need to create a schema for that credential, which basically is the set of JSON files that gather all the attributes of that specific credential. +## Issue the POAP credential -To facilitate this issuance process, we have already created the credential schema with schema type POAP01 whose URLs are the following: +You will now take the role of an Issuer, in this example, the private institution/trusted entity that held the event and creates a POAP. The Issuer is responsible for both creating the credential and sending it to the ID Holder. -- JSON schema URL - `ipfs://QmTSwnuCB9grYMB2z5EKXDagfChurK5MiMCS6efrRbsyVX` -- JSON-LD Context - `ipfs://QmdH1Vu79p2NcZLFbHxzJnLuUHJiMZnBeT7SNpLaqK7k9X` +We will use the Issuer Node UI Demo environment to manage credentials. This environment enables an Issuer to create and manage identities and credentials, generate connections, and manage schemas. :::note -To learn how to set up your own issuer environment by deploying an issuer node, visit the [Issuer section in the documentation](./issuer/issuer-overview.md). +When an Issuer releases a new credential type, they create a schema for that credential. This requires a set of JSON key pair data or files that gather all the attributes of that specific credential. + +[Learn how to set up your own Issuer environment by deploying an Issuer node](/docs/issuer/issuer-overview.md). ::: +To simplify this demo issuance, we provide an existing credential schema with schema type POAP01: + + + + +```ipfs://QmTSwnuCB9grYMB2z5EKXDagfChurK5MiMCS6efrRbsyVX``` + +> View this credential's data using an online gateway. + + + + + + +```ipfs://QmdH1Vu79p2NcZLFbHxzJnLuUHJiMZnBeT7SNpLaqK7k9X``` + +> View this credential's data using an online gateway. + + + + + :::info The schema used in this demo was built using the Privado ID Schema Builder and is available on [the Privado ID Schema Explorer](https://tools.privado.id/schemas/1fa99457-b2ae-4884-ae12-d658bd6abf69). Learn more about creating new schemas on [the Schema Builder UI guide](/docs/issuer/schema-builder/). ::: -### Issue a new credential to attest to the ID Holder's attendance to the event +### Generate the credential -With the new schema in hand, the issuer should now be able to generate a credential. +With the new schema in hand, the Issuer can generate a credential. -1. First, go to the the Issuer Node UI testing environment. +1. Navigate to the Issuer Node UI testing environment. :::warning - This Issuer Node is publicly available and used only for testing purposes. Do not use personal or sensitive data. All data is deleted every 48 hours. + Only use this publicly available Issuer Node for testing purposes. Do not submit personal or sensitive data. All data is deleted every 48 hours. ::: -2. Now you need to import the schema. Click on **Import Schema** and paste our previously generated schema IPFS address `ipfs://QmTSwnuCB9grYMB2z5EKXDagfChurK5MiMCS6efrRbsyVX`: +2. Next, import the schema. + + 2.1 Click on **Import Schema** and paste the schema's IPFS address `ipfs://QmTSwnuCB9grYMB2z5EKXDagfChurK5MiMCS6efrRbsyVX`: -
- -
+
+ +
- You may preview the schema and then Import it. + 2.2 Preview the schema and then Import it. -3. You can go ahead and click on **Issue Credential** in the top righ-hand corner. Choose **Credential Link** on the next page and your schema on the dropdown menu ("POAP01", in our case). For this credential, we are providing a proof of attendance to an event in Paris: +3. Next, click on **Issue Credential** in the top right-hand corner. Choose **Credential Link** on the next page and your schema on the dropdown menu ("POAP01", in our case). For this credential, we are providing a proof of attendance at an event in Paris:
-4. After you click on **Create Credential Link**, you'll be presented with a Universal Link and a Deep Link to the credential offer, along with a QR code configured for these links. The QR code can be scanned directly with the Privado ID Wallet app. +4. Click on **Create Credential Link** to be presented with a Universal Link and a Deep Link to the credential offer, along with a QR code configured for these links. The QR code can be scanned directly with the Privado ID Wallet app, that is, the Mobile App. :::info - When the user interacts with the [Universal Link](/docs/wallet/universal-links.md) , it will launch the Privado ID Web Wallet in the browser or Privado ID Wallet app in case of a mobile phone displaying the credential offer to claim the credential. Deep link could be handled only by mobile wallet app though. + When the user interacts with the [Universal Link](/docs/wallet/universal-links.md), it will launch the Privado ID Web Wallet in the browser or Privado ID Wallet app in case of a mobile phone displaying the credential offer to claim the credential. The Deep link supports the Mobile Wallet App. ::: @@ -116,15 +151,17 @@ With the new schema in hand, the issuer should now be able to generate a credent ## Fetch the newly created credential -Now we are back to the ID Holder role. You can either use the Web Wallet on the browser or the Wallet App to accept the credential via the link or the QR code generated by the issuer in the last step. +Next, you will take the second role in this tutorial: the ID Holder. You can either use the Web Wallet in the browser or the Mobile Wallet App to accept the credential via the link or the QR code generated by the Issuer in the previous step. :::note + To sync the identity and its associated credentials between the Privado ID Web Wallet and the Privado ID Wallet App, the user must log in with the same crypto wallet account on both platforms. Once you claim a credential on one platform, it will be visible on the other. + ::: #### Web Wallet -After clicking the Universal link, it will take you to the Web Wallet. Click **Sign In** and connect your crypto wallet such as Metamask. Click **Add to my wallet**. This should add the credential to your wallet. +After clicking the Universal link, it will take you to the Web Wallet. Click **Sign In** and connect your crypto wallet such as MetaMask. Click **Add to my wallet**. This should add the credential to your wallet.
@@ -148,23 +185,23 @@ Alternatively, Scan the QR code from the Wallet App. Click **Sign In**. This sho ## Verify the ID holder credential -Here comes the third role in this tutorial: the verifier. This could be represented by an organization that needs to verify some details of someone's credentials. In our use case, this organization wants to verify whether the ID holder actually attended our made-up Paris event. +Next, you will take the third role in this tutorial: the Verifier. This might be an organization that needs to verify some details of someone's credentials. In our use case, this organization wants to verify whether the ID holder actually attended our made-up Paris event. Here are the steps to verify the credential: -1. Visit the [Query builder website](https://tools.privado.id/query-builder/). The [Query Builder](/docs/verifier/query-builder/) is a tool designed to simplify the creation of verification queries. +1. Visit the [Query Builder website](https://tools.privado.id/query-builder/). The [Query Builder](/docs/verifier/query-builder/) is a tool designed to simplify the creation of verification queries.
-2. You now need to define the query. You will now make use of the JSON-LD URL which we have also provided: `ipfs://QmdH1Vu79p2NcZLFbHxzJnLuUHJiMZnBeT7SNpLaqK7k9X`. Here is how the query should look like: +2. Define the query. We will use the existing JSON-LD URL: `ipfs://QmdH1Vu79p2NcZLFbHxzJnLuUHJiMZnBeT7SNpLaqK7k9X`. The query should look like this:
-3. Click **Create Query**. Now click **Test query** button which will take you the Privado ID Web Wallet +3. Click **Create Query**. Now click **Test query** button which will take you to the Privado ID Web Wallet:
@@ -176,12 +213,12 @@ Here are the steps to verify the credential:
-5. Finally, the proof is generated and sent to the verifier. The verifier will then check the revocation status and any additional information to validate the proof. You will receive the following response on the Query Builder website: +5. Finally, the proof is generated and sent to the Verifier. The Verifier will then check the revocation status and any additional information to validate the proof. You will receive the following response on the Query Builder website:
-Alternatively, you can also use Privado ID Wallet app to verify. +Alternatively, you can also use the Privado ID Wallet app to verify. After Step 3, once you are redirected to Web Wallet, click on **Continue via app**, this should present a QR code. Open the Privado ID Wallet App and scan the QR code. Click on **Verify** @@ -194,4 +231,3 @@ Click on **Verify** This quick-start guide demonstrates Privado ID’s basic functionalities through a POAP use case, covering wallet setup, credential issuance, retrieval, and verification. While this is a simplified example, Privado ID provides a comprehensive suite of SSI tools for managing decentralized identity and verifiable credentials. - From 642bdb4b8a186de2f009da217882bb01bd608507 Mon Sep 17 00:00:00 2001 From: m4sterbunny <20266893+m4sterbunny@users.noreply.github.com> Date: Thu, 28 Nov 2024 11:35:14 +0000 Subject: [PATCH 2/7] responds to review --- docs/quick-start-demo.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/quick-start-demo.md b/docs/quick-start-demo.md index 943fa688..9dec138b 100644 --- a/docs/quick-start-demo.md +++ b/docs/quick-start-demo.md @@ -26,7 +26,7 @@ This guide will briefly touch on the 3 roles of the [Triangle of Trust](introduc In this tutorial, you will: 1. [Set up a Privado ID wallet](#set-up-a-privado-id-wallet) -2. [Issue a new credential to attest to the ID Holder's attendance to the event](#issue-the-poap-credential) +2. [Issue the POAP credential](#issue-the-poap-credential) 3. [Fetch the newly created credential](#fetch-the-newly-created-credential) 4. [Verify the ID holder credential](#verify-the-id-holder-credential) @@ -137,11 +137,15 @@ With the new schema in hand, the Issuer can generate a credential.
-4. Click on **Create Credential Link** to be presented with a Universal Link and a Deep Link to the credential offer, along with a QR code configured for these links. The QR code can be scanned directly with the Privado ID Wallet app, that is, the Mobile App. +4. Click on **Create Credential Link** to be presented with links and a QR code configured for these links to claim the credential. :::info - When the user interacts with the [Universal Link](/docs/wallet/universal-links.md), it will launch the Privado ID Web Wallet in the browser or Privado ID Wallet app in case of a mobile phone displaying the credential offer to claim the credential. The Deep link supports the Mobile Wallet App. + Two link types are created, one for the Web App and another for the Mobile App: + - Deep Link supports the Mobile Wallet App only + - The [Universal Link](/docs/wallet/universal-links.md) supports the Web App only + + The QR code can be scanned directly with the Privado ID Wallet app, that is, the Mobile App. ::: From c5a96ecdfe0d433d1cd509627cdc8001b4c43deb Mon Sep 17 00:00:00 2001 From: m4sterbunny <20266893+m4sterbunny@users.noreply.github.com> Date: Thu, 28 Nov 2024 11:48:37 +0000 Subject: [PATCH 3/7] responds to review --- docs/quick-start-demo.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quick-start-demo.md b/docs/quick-start-demo.md index 9dec138b..52375e10 100644 --- a/docs/quick-start-demo.md +++ b/docs/quick-start-demo.md @@ -75,7 +75,7 @@ We will use the Issuer Node UI Demo en :::note -When an Issuer releases a new credential type, they create a schema for that credential. This requires a set of JSON key pair data or files that gather all the attributes of that specific credential. +When an Issuer releases a new credential type, they create a schema for that credential. This takes the form of a JSON dataset that gathers all the attributes of that specific credential. [Learn how to set up your own Issuer environment by deploying an Issuer node](/docs/issuer/issuer-overview.md). From e40f01df213296027febae52185adac3d26a025b Mon Sep 17 00:00:00 2001 From: m4sterbunny <20266893+m4sterbunny@users.noreply.github.com> Date: Fri, 29 Nov 2024 12:54:27 +0000 Subject: [PATCH 4/7] responds to review and standardizes use of wallet vs app in flow --- docs/quick-start-demo.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/quick-start-demo.md b/docs/quick-start-demo.md index 52375e10..3e4bd6e6 100644 --- a/docs/quick-start-demo.md +++ b/docs/quick-start-demo.md @@ -44,7 +44,7 @@ To get started with the Privado ID Wallet, you either visit the [Privado ID Web - + Privado ID Web Wallet @@ -54,7 +54,7 @@ The Privado ID Web Wallet is a web-based identity wallet. It is a reference impl - + - Android: Privado ID Wallet App on Google Play - iOS: Privado ID Wallet App on the App Store @@ -75,7 +75,7 @@ We will use the Issuer Node UI Demo en :::note -When an Issuer releases a new credential type, they create a schema for that credential. This takes the form of a JSON dataset that gathers all the attributes of that specific credential. +When an Issuer releases a new credential type, they create a schema representation of the credential. This comprises a set of JSON files that gather all the credential's attributes. [Learn how to set up your own Issuer environment by deploying an Issuer node](/docs/issuer/issuer-overview.md). @@ -163,7 +163,9 @@ To sync the identity and its associated credentials between the Privado ID Web W ::: -#### Web Wallet + + + After clicking the Universal link, it will take you to the Web Wallet. Click **Sign In** and connect your crypto wallet such as MetaMask. Click **Add to my wallet**. This should add the credential to your wallet. @@ -177,21 +179,25 @@ Click on **Manage your credentials** to view and manage the credential in the We
+ -#### Mobile Wallet App + -Alternatively, Scan the QR code from the Wallet App. Click **Sign In**. This should authenticate and add the credential to the Wallet. +Alternatively, scan the QR code. Click **Sign In**. This should authenticate and add the credential to the Wallet.
+ + + ## Verify the ID holder credential Next, you will take the third role in this tutorial: the Verifier. This might be an organization that needs to verify some details of someone's credentials. In our use case, this organization wants to verify whether the ID holder actually attended our made-up Paris event. -Here are the steps to verify the credential: +To verify the credential: 1. Visit the [Query Builder website](https://tools.privado.id/query-builder/). The [Query Builder](/docs/verifier/query-builder/) is a tool designed to simplify the creation of verification queries. @@ -230,7 +236,6 @@ Click on **Verify** -

This quick-start guide demonstrates Privado ID’s basic functionalities through a POAP use case, covering wallet setup, credential issuance, retrieval, and verification. While this is a simplified example, Privado ID provides a comprehensive suite of SSI tools for managing decentralized identity and verifiable credentials. From de13023382c6acb4354359ee1563bcc6718d14e0 Mon Sep 17 00:00:00 2001 From: m4sterbunny <20266893+m4sterbunny@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:28:04 +0000 Subject: [PATCH 5/7] responds to review: returns JSON plural and further rationalizations --- docs/quick-start-demo.md | 63 +++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 33 deletions(-) diff --git a/docs/quick-start-demo.md b/docs/quick-start-demo.md index 3e4bd6e6..ca13d351 100644 --- a/docs/quick-start-demo.md +++ b/docs/quick-start-demo.md @@ -18,12 +18,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This tutorial is a quick demonstration of some of Privado ID's main functionalities. To illustrate how Privado ID works, we will walk you through some of its products and tools by following along a simple POAP use case. -POAP stands for Proof of Attendance Protocol, which is used to prove that someone has taken part in a given event. +This tutorial illustrates Privado ID's main functionalities. It walks through Privado ID's products and tools by presenting a simple POAP use case. POAP stands for Proof of Attendance Protocol, which is used to prove that someone has taken part in a given event. -This guide will briefly touch on the 3 roles of the [Triangle of Trust](introduction.md#core-concepts-of-privado-id-verifiable-credentials-identity-holder-issuer-and-verifier), namely the Identity Holder, the Issuer, and the Verifier. For that, we will take the case of an individual who needs to prove that they were able to participate in a particular event. - -In this tutorial, you will: +In this tutorial, you will assume each of the 3 roles required by the [Triangle of Trust](introduction.md#core-concepts-of-privado-id-verifiable-credentials-identity-holder-issuer-and-verifier): the Identity Holder, the Issuer, and the Verifier. You will: 1. [Set up a Privado ID wallet](#set-up-a-privado-id-wallet) 2. [Issue the POAP credential](#issue-the-poap-credential) @@ -32,24 +29,24 @@ In this tutorial, you will: ## Set up a Privado ID wallet -To store verifiable credentials, the Identity Holder (the individual receiving the credential) needs a compatible wallet. Here, we’ll use the Privado ID Wallet, which supports both mobile and web-based access. +To store verifiable credentials, the Identity Holder (the individual receiving the credential) needs a compatible wallet. Here, we’ll use the Privado ID Wallet, which supports both Mobile and Web-based access. :::note -You may use any Privado ID compatible wallet. See our [Ecosystem page](https://marketplace.privado.id/ecosystem) for other options. +You may use any Privado ID compatible wallet. Our [Ecosystem page](https://marketplace.privado.id/ecosystem) lists all supported wallets. ::: -To get started with the Privado ID Wallet, you either visit the [Privado ID Web Wallet](https://wallet.privado.id/) in your browser or download the Mobile App and create an Identity. +To get started with the Privado ID Wallet, either visit the [Privado ID Web Wallet](https://wallet.privado.id/) in your browser or download the Mobile App and create an Identity. - + Privado ID Web Wallet :::note -The Privado ID Web Wallet is a web-based identity wallet. It is a reference implementation built using our [JS SDK](/docs/js-sdk/js-sdk-overview.md). [Learn more about the Web Wallet](/docs/wallet/web-wallet.md). +The Privado ID Web Wallet is a Web-based identity wallet. It is a reference implementation built using our [JS SDK](/docs/js-sdk/js-sdk-overview.md). [Learn more about the Web Wallet](/docs/wallet/web-wallet.md). ::: @@ -60,7 +57,7 @@ The Privado ID Web Wallet is a web-based identity wallet. It is a reference impl - iOS: Privado ID Wallet App on the App Store :::note -Privado ID Wallet App is an implementation of the [Wallet SDK](/docs/category/wallet-sdk), as a way of showcasing its possibilities. [Learn more about the Wallet App](/docs/wallet/wallet-app/privadoid-app.md). +Privado ID Wallet App is an implementation of the [Wallet SDK](/docs/category/wallet-sdk), as a way of showcasing its possibilities. [Learn more about the Molbile Wallet](/docs/wallet/wallet-app/privadoid-app.md). ::: @@ -69,7 +66,7 @@ Privado ID Wallet App is an implementation of the [Wallet SDK](/docs/ ## Issue the POAP credential -You will now take the role of an Issuer, in this example, the private institution/trusted entity that held the event and creates a POAP. The Issuer is responsible for both creating the credential and sending it to the ID Holder. +You will now take the role of an Issuer, in this example, the private institution/trusted entity that held the event and creates a POAP. The Issuer is responsible for both creating the credential and sending it to the Identity Holder. We will use the Issuer Node UI Demo environment to manage credentials. This environment enables an Issuer to create and manage identities and credentials, generate connections, and manage schemas. @@ -93,7 +90,7 @@ To simplify this demo issuance, we provide an existing credential schema with sc - + ```ipfs://QmdH1Vu79p2NcZLFbHxzJnLuUHJiMZnBeT7SNpLaqK7k9X``` @@ -105,7 +102,7 @@ To simplify this demo issuance, we provide an existing credential schema with sc :::info -The schema used in this demo was built using the Privado ID Schema Builder and is available on [the Privado ID Schema Explorer](https://tools.privado.id/schemas/1fa99457-b2ae-4884-ae12-d658bd6abf69). Learn more about creating new schemas on [the Schema Builder UI guide](/docs/issuer/schema-builder/). +The schema used in this demo was built using the Privado ID Schema Builder and is available on [the Privado ID Schema Explorer](https://tools.privado.id/schemas/1fa99457-b2ae-4884-ae12-d658bd6abf69). Learn more about creating new schemas from [the Schema Builder UI guide](/docs/issuer/schema-builder/). ::: @@ -141,11 +138,11 @@ With the new schema in hand, the Issuer can generate a credential. :::info - Two link types are created, one for the Web App and another for the Mobile App: - - Deep Link supports the Mobile Wallet App only - - The [Universal Link](/docs/wallet/universal-links.md) supports the Web App only + Two link types are created, one for the Web Wallet and another for the Mobile Wallet: + - Deep Link supports the Mobile Wallet only + - The [Universal Link](/docs/wallet/universal-links.md) supports the Web Wallet only - The QR code can be scanned directly with the Privado ID Wallet app, that is, the Mobile App. + The QR code can be scanned directly with the Privado ID Wallet app, that is, the Mobile Wallet. ::: @@ -155,47 +152,47 @@ With the new schema in hand, the Issuer can generate a credential. ## Fetch the newly created credential -Next, you will take the second role in this tutorial: the ID Holder. You can either use the Web Wallet in the browser or the Mobile Wallet App to accept the credential via the link or the QR code generated by the Issuer in the previous step. +Next, you will take the second role in this tutorial: the ID Holder. You can either use the Web Wallet in the browser or the Mobile Wallet to accept the credential via the link or the QR code generated by the Issuer in the previous step. :::note -To sync the identity and its associated credentials between the Privado ID Web Wallet and the Privado ID Wallet App, the user must log in with the same crypto wallet account on both platforms. Once you claim a credential on one platform, it will be visible on the other. +To sync the identity and its associated credentials between the Privado ID Web Wallet and the Privado ID Mobile Wallet, the user must log in with the same crypto wallet account on both platforms. Once you claim a credential on one platform, it will then be visible on the other. ::: +To fetch the credential: -After clicking the Universal link, it will take you to the Web Wallet. Click **Sign In** and connect your crypto wallet such as MetaMask. Click **Add to my wallet**. This should add the credential to your wallet. +1. Click the Universal link, which will take you to the Web Wallet. Click **Sign In** and connect your crypto wallet such as MetaMask. Click **Add to my wallet**. This should add the credential to your wallet.
- -Click on **Manage your credentials** to view and manage the credential in the Web Wallet. - -
- -
 -Alternatively, scan the QR code. Click **Sign In**. This should authenticate and add the credential to the Wallet. +1. Scan the QR code. Click **Sign In**. This should authenticate and add the credential to the Wallet.
- +2. Click on **Manage your credentials** to view and manage the credential in the Wallet. + +
+ +
+ ## Verify the ID holder credential -Next, you will take the third role in this tutorial: the Verifier. This might be an organization that needs to verify some details of someone's credentials. In our use case, this organization wants to verify whether the ID holder actually attended our made-up Paris event. +Next, you will take the third role in this tutorial: the Verifier. This might be an organization that needs to verify some details of a person's credentials. In our use case, this organization wants to verify whether the Identity Holder actually attended our made-up Paris event. To verify the credential: @@ -211,13 +208,13 @@ To verify the credential: -3. Click **Create Query**. Now click **Test query** button which will take you to the Privado ID Web Wallet: +3. Click **Create Query**. Now click the **Test query** button which will take you to the Privado ID Web Wallet:
-4. Click **Sign in** and connect your crypto wallet. As you have already claimed the credential, it shows as 'claimed'. Click **Verify**, after which the process of generating the proof starts. +4. Click **Sign in** and connect your crypto wallet. As you have already claimed the credential, it shows as 'claimed'. Click **Verify**, to initiate the process of generating the proof.
@@ -238,5 +235,5 @@ Click on **Verify**

-This quick-start guide demonstrates Privado ID’s basic functionalities through a POAP use case, covering wallet setup, credential issuance, retrieval, and verification. While this is a simplified example, Privado ID provides a comprehensive suite of SSI tools for managing decentralized identity and verifiable credentials. +This quick-start guide demonstrates Privado ID’s basic functionalities through a POAP use case, covering wallet setup, credential issuance, retrieval, and verification. This example requires the user to participate in all three roles to demonstrate Privado ID's comprehensive suite of Self-Sovereign Identity (SSI) tools for managing decentralized identity and verifiable credentials. In real-world uses cases, a single entity would typically fit just one of these roles. From 634f537a8d871fcc5346e481d67969dcb5eb4ef7 Mon Sep 17 00:00:00 2001 From: m4sterbunny <20266893+m4sterbunny@users.noreply.github.com> Date: Thu, 12 Dec 2024 16:34:03 +0000 Subject: [PATCH 6/7] responds to review --- docs/quick-start-demo.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/quick-start-demo.md b/docs/quick-start-demo.md index ca13d351..db73a67d 100644 --- a/docs/quick-start-demo.md +++ b/docs/quick-start-demo.md @@ -134,15 +134,13 @@ With the new schema in hand, the Issuer can generate a credential.
-4. Click on **Create Credential Link** to be presented with links and a QR code configured for these links to claim the credential. +4. Click on **Create Credential Link** to be presented with links and a QR code configured for these links to claim the credential. The QR code can be scanned directly with supporting mobile apps, e.g. the Privado Mobile Wallet app. :::info - Two link types are created, one for the Web Wallet and another for the Mobile Wallet: - - Deep Link supports the Mobile Wallet only - - The [Universal Link](/docs/wallet/universal-links.md) supports the Web Wallet only - - The QR code can be scanned directly with the Privado ID Wallet app, that is, the Mobile Wallet. + Two link types are created to provide access to the credential: + - Mobile Wallet apps such as the Privado ID Mobile App and other supported mobile wallets support Deep Link + - The Privado ID Web Wallet and other Mobile Wallet apps [ support the Universal Link](/docs/wallet/universal-links.md) ::: From 33b911a2edeaf39bf39ca203fea6170eccc61a27 Mon Sep 17 00:00:00 2001 From: Pulkit Mittal Date: Thu, 23 Jan 2025 14:07:31 +0530 Subject: [PATCH 7/7] fixed domains for the main site and other tools --- docusaurus.config.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index bb9adcc5..40cbc23d 100755 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -6,7 +6,7 @@ require("dotenv").config(); module.exports = { title: "Privado ID Documentation", tagline: "The official developer documentation hub for Privado ID.", - url: "https://devs.polygonid.com", + url: "https://docs.privado.id", baseUrl: "/", favicon: "/img/privado_favicon.png", organizationName: "0xPolygonID", @@ -112,19 +112,19 @@ module.exports = { label: "Tools", items: [ { - href: "https://schema-builder.polygonid.me/", + href: "https://tools.privado.id", label: "Schema Explorer", }, { - href: "https://schema-builder.polygonid.me/builder", + href: "https://tools.privado.id/builder", label: "Schema Builder", }, { - href: "https://schema-builder.polygonid.me/query-builder", + href: "https://tools.privado.id/query-builder", label: "Query Builder", }, { - href: "https://jwz.polygonid.me", + href: "https://jwz-validator.privado.id", label: "JWZ Validator", }, ],