Skip to content

Commit

Permalink
GITBOOK-300: change request with no subject merged in GitBook
Browse files Browse the repository at this point in the history
  • Loading branch information
Tweeddalex authored and gitbook-bot committed Jun 13, 2024
1 parent 0bea3d2 commit 1c9c475
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
8 changes: 4 additions & 4 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
* [Bulk Update or Rotate Encryption Keys](credential-service/payments/update.md)
* [🎋 Create Status Lists](credential-service/status-lists/README.md)
* [Status List v2021](credential-service/status-lists/status-list-v2021/README.md)
* [Create Status List v2021](credential-service/status-lists/status-list-v2021/create-status-list.md)
* [Update Status List v2021](credential-service/status-lists/status-list-v2021/update-status-list.md)
* [Check Status List v2021](credential-service/status-lists/status-list-v2021/check.md)
* [Search Status List v2021](credential-service/status-lists/status-list-v2021/search.md)
* [Create Status List v2021](credential-service/status-lists/create-status-list.md)
* [Update Status List v2021](credential-service/status-lists/update-status-list.md)
* [Check Status List v2021](credential-service/status-lists/check.md)
* [Search Status List v2021](credential-service/status-lists/search.md)
* [Token Status List](credential-service/status-lists/token-status-list/README.md)
* [Create Token Status List](credential-service/status-lists/token-status-list/create-token-status-list.md)
* [Update Token Status List](credential-service/status-lists/token-status-list/update-token-status-list.md)
Expand Down
2 changes: 1 addition & 1 deletion credential-service/payments/charge.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Using this API will create a regular Status List on-ledger, where the contents o

</details>

For the purpose of this tutorial, we will assume the user is creating an encrypted Status List. For unencrypted Status Lists, [follow the tutorial here](../status-lists/status-list-v2021/create-status-list.md).
For the purpose of this tutorial, we will assume the user is creating an encrypted Status List. For unencrypted Status Lists, [follow the tutorial here](../status-lists/create-status-list.md).

## Step 4: Create encrypted Status List

Expand Down
12 changes: 6 additions & 6 deletions credential-service/status-lists/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
description: Create a Verifiable Credential Status List on-ledger
description: >-
Create, update and fetch Status Lists on cheqd, stored as a DID-Linked
Resources
---

# 🎋 Create Status Lists

Credential Status Lists are generally sets of indices which can be used to mathematically derive whether an issued Credential has been revoked, suspended or is still valid. Status Lists are crucial for verifier applications to determine whether to accept a credential, presented by a holder.
Status Lists are generally sets of indices which can be used to mathematically derive whether an issued Credential has been revoked, suspended or is still valid. Status Lists are crucial for verifier applications to determine whether to accept a credential, presented by a holder.

## Get started

Expand All @@ -14,8 +16,6 @@ There are two predominant Status List formats supported in cheqd Studio. Please

## Alternatives

Below are a list of alternatives for creating cheqd Status Lists.
Below are a list of alternatives for creating Status Lists on cheqd.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>DID Registrar</strong></mark></td><td>Simple setup for building cheqd DIDs into existing applications using REST APIs, building into the <a href="https://uniregistrar.io/">Universal Registrar</a>.</td><td><a href="../../advanced/did-registrar/">did-registrar</a></td></tr><tr><td><mark style="color:blue;"><strong>Veramo SDK Plugin</strong></mark></td><td>The <strong>Veramo SDK Plugin</strong> is an extension of the Veramo SDK, a JavaScript framework for Trusted Data, adding support for cheqd functionality.</td><td><a href="../../sdk/veramo-plugin/">veramo-plugin</a></td></tr></tbody></table>

t
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>DID Registrar</strong></mark></td><td>Simple setup for building cheqd DIDs into existing applications using REST APIs, building into the <a href="https://uniregistrar.io/">Universal Registrar</a>.</td><td><a href="../../advanced/did-registrar/">did-registrar</a></td></tr><tr><td><mark style="color:blue;"><strong>Veramo SDK Plugin</strong></mark></td><td>The <strong>Veramo SDK Plugin</strong> is an extension of the Veramo SDK, a JavaScript framework for Trusted Data, adding support for cheqd functionality.</td><td><a href="../../sdk/veramo-plugin/">veramo-plugin</a></td></tr><tr><td><mark style="color:blue;"><strong>AnonCreds Accumulator Revocation</strong></mark></td><td>Follow the cheqd AnonCreds Object Method to create Accumulator-based Status Lists</td><td><a href="../../advanced/anoncreds/">anoncreds</a></td></tr></tbody></table>
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The index within the bitstring that the user wants to query. For example:

To automatically make a payment to an Issuer in order to verify an encrypted Status List, follow the tutorial here:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Verifier pays Issuer</strong></mark></td><td>Understand how a Verifier pays an Issuer to decrypt an encrypted Status List and verify a Credential Status.</td><td><a href="../../payments/verifier-pays-issuer.md">verifier-pays-issuer.md</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Verifier pays Issuer</strong></mark></td><td>Understand how a Verifier pays an Issuer to decrypt an encrypted Status List and verify a Credential Status.</td><td><a href="../payments/verifier-pays-issuer.md">verifier-pays-issuer.md</a></td></tr></tbody></table>

### Option 2. Publish a JSON Payload

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ Users are able to create [Verifiable Credential Status List v2021](https://www.w

Make sure you have set up your account with cheqd Studio and are logged in, using our guide below:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Set up your account</strong></mark></td><td>Set up your account with cheqd Studio and log in to start using the APIs.</td><td><a href="../../set-up-account.md">set-up-account.md</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Set up your account</strong></mark></td><td>Set up your account with cheqd Studio and log in to start using the APIs.</td><td><a href="../set-up-account.md">set-up-account.md</a></td></tr></tbody></table>

## Step 2: Create a DID

Before you can create a Status List, you need to create a DID which is used to link the Status List on-ledger. Use the API in the page below to create a DID:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Create an Issuer DID</strong></mark></td><td>Create a W3C conformant DID on cheqd using the <code>did:cheqd</code> DID Method.</td><td><a href="../../dids/create-did.md">create-did.md</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Create an Issuer DID</strong></mark></td><td>Create a W3C conformant DID on cheqd using the <code>did:cheqd</code> DID Method.</td><td><a href="../dids/create-did.md">create-did.md</a></td></tr></tbody></table>

## Step 3: Select the unencrypted Status List API

When [creating a Status List](../), a user will have the following options:&#x20;
When [creating a Status List](./), a user will have the following options:&#x20;

<details>

Expand All @@ -38,7 +38,7 @@ Using this API will create a regular Status List on-ledger, where the contents o

</details>

For the purpose of this tutorial, we will assume the user is creating an unencrypted Status List. For encrypted Status Lists, [follow the tutorial here](../../payments/charge.md).
For the purpose of this tutorial, we will assume the user is creating an unencrypted Status List. For encrypted Status Lists, [follow the tutorial here](../payments/charge.md).

## Step 4: Create unencrypted Status List

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Search Status List
# Search Status List v2021

The `/credential-status/search` API allows users to search for specific entries of a Status List on the cheqd network. For example, if there are multiple Status Lists associated with the same DID, the search functionality allows applications to make requests only to a specified Status List.&#x20;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: Update indices in Status List
---

# Update Status List
# Update Status List v2021

The `/credential-status/update/unencrypted` API enables users to update the indices of a Status List. This may be useful for revoking Credentials in bulk, rather than submitting individual `/credential/revoke` requests.

Expand Down

0 comments on commit 1c9c475

Please sign in to comment.