Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add documentation for revoking and activating a VC #223

Merged
merged 4 commits into from
Oct 28, 2024
Merged

docs: add documentation for revoking and activating a VC #223

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea70826
docs: add Revoke a VC and Activate a VC docs
huynguyen-hl Oct 16, 2024
efe3975
docs: add documentation for revoking and activating a VC
huynguyen-hl Oct 17, 2024
afdb319
Merge branch 'next' into docs/activate-revoke-vc-doc
huynguyen-hl Oct 17, 2024
ebcacf0
docs: add Issuing a status VC flow into documentation site. [skip ci]
huynguyen-hl Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions documentation/docs/get-started/api-server-get-started/basic-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,3 +270,51 @@ To get the rendered VC, you can try this endpoint [`/renderCredential`](http://l
:::tip
The document value is a string which is a encoded HTML string. You can use any online [Base64](https://www.base64decode.org/) tool out there to decode it. Good luck!
:::

## Revoking a VC

To revoke a VC, use the following VCKit API endpoint: [/agent/setBitstringStatus](http://localhost:3332/agent/setBitstringStatus).
huynguyen-hl marked this conversation as resolved.
Show resolved Hide resolved

### Request body:

```json
{
"statusListCredential": "http://localhost:3332/credentials/status/bitstring-status-list/26",
"statusListVCIssuer": "did:web:example.com",
"statusPurpose": "revocation",
"index": 0,
"status": true
}
```

### Expected response:

```json
{
"status": true
}
```

## Activating a VC

To activate a VC, use the following VCKit API endpoint: [/agent/setBitstringStatus](http://localhost:3332/agent/setBitstringStatus).

### Request body:

```json
{
"statusListCredential": "http://localhost:3332/credentials/status/bitstring-status-list/26",
"statusListVCIssuer": "did:web:example.com",
"statusPurpose": "revocation",
"index": 0,
"status": false
}
```

### Expected response:

```json
{
"status": false
}
```
Loading