LogoLogo
ProductsCommunityGitHubShare Feedback
SSI Kit
SSI Kit
  • General
    • Introduction
    • Transition To The Community Stack
    • SSI Kit | Basics
      • Overview
      • Functionality
      • Components
    • SSI Kit
      • SSI Flavors & Ecosystems
        • Trust Registries
        • Keys
        • Decentralized Identifiers (DIDs)
        • Verifiable Credentials (VCs)
        • Data Exchange Protocols
      • Architecture
        • Low-Level Service Abstraction
        • Ecosystem Abstraction
        • High-Level Interfaces / APIs
      • Use Cases
      • Self-Sovereign Identity (SSI)
        • SSI | Basics
        • Technologies & Concepts
          • Registries
          • Decentralised Identifiers (DIDs)
          • Verifiable Credentials (VCs)
          • Verifiable Presentations (VPs)
          • Data Exchange (Protocols)
  • Getting started
    • Quick Start
    • REST API
      • Signatory API - For Issuers
      • Custodian API - For Holders
        • Key management
        • Did management
        • Credentials management
      • Auditor API - For Verifiers
      • Core API
        • Cryptographic keys
        • Decentralised-Identifiers
        • Verifiable-Credentials
      • API Serving Configs
    • Dependency (JVM)
      • Java Examples
      • Kotlin Examples
    • CLI | Command Line Interface
      • Key Management
      • Decentralized Identifiers
      • Verifiable Credentials
      • OpenID Connect (OIDC)
    • Building the Project
      • Docker Build
      • Local Build
    • Project Configurations
    • Demo
  • Ecosystems
    • EBSI
      • Basics
      • Use Cases & Flow Diagrams
      • Command line interface
        • DID Registration
      • REST API
      • Usage / examples
        • Onboarding & DIDs
        • Build end-to-end use cases
    • IOTA
      • OIDC4VP profile for Login-with-IOTA
      • Login With IOTA Demo
    • Velocity
      • Basics
        • Onboarding
        • Issuing
        • Inspection
      • Integration with SSIKit
      • Command line interface
        • Onboarding
        • Issuing
        • Inspection
    • cheqd
      • Integration architecture
      • Create DID
      • Issue VC
      • Verify VC
  • Tutorials
    • My First VC
    • Advanced VC
  • Concepts
    • Credential Templates
    • Verification Policies
      • Static Policies
      • Parameterized Policies
      • Dynamic/Custom Policies
        • Creating Dynamic Policies
        • Using Dynamic Policies
        • Removing Dynamic Policies
        • Dynamic Policies | Data Classes
    • Selective Disclosure
      • Intro
      • Issuing a SD-JWT Credential
      • Verifying a SD-JWT Credential
    • Credential Statuses
      • StatusList2021Entry
      • SimpleCredentialStatus2022
      • Issue credentials with credentialStatus
      • REST API
        • Check the status of a credential
        • Revoke a credential
      • CLI
        • Check the status of a credential
        • Revoke a credential
    • DID Web
    • Open Policy Agent (OPA)
      • Setup
    • OpenID Connect (OIDC)
      • Credential Issuance
        • OIDC4CI | Example
      • Presentation Exchange
        • OIDC4VP | Example
    • Delegation and Mandates
  • Community
    • Discord
    • Twitter
    • Newsletter
    • GitHub Discussions
  • DEVELOPER RELATIONS
    • Contribute
    • Roadmap
    • Share Feedback
    • Contact
  • Product Editions
    • Open Source | Always Free
    • Enterprise | Self-Managed
    • Cloud Platform | Managed
Powered by GitBook
On this page
  • Issue and save VC
  • Present VC
  • Verify VC or VP
  • List verification policies
  • Import VC to custodian store
  • VC templates
  • List VCs

Was this helpful?

Export as PDF
  1. Getting started
  2. CLI | Command Line Interface

Verifiable Credentials

VC related operations like issuing, verifying and revoking VCs.

PreviousDecentralized IdentifiersNextOpenID Connect (OIDC)

Last updated 1 month ago

Was this helpful?

VC related operations like issuing, verifying and revoking VCs. If you're new to VCs, check out the for an overview.

Commands:

  • - using issue command

  • - using present command

  • - using verify command

  • - using policies command

  • - using import command

  • - using templates command

  • - using list command

All commands have the help option available:

  • <your-command> -h

  • or <your-command> --help

E.g. vc issue -h

Issue and save VC

Use the issue command to issue a W3C Verifiable Credential with either a JWT or a JSON_LD signature.

options:

  • -i, --issuer-did TEXT DID of the issuer (associated with signing key). [Required]

  • -s, --subject-did TEXT DID of the VC subject (receiver of VC). [Required]

  • -v, --issuer-verification-method TEXT KeyId of the issuers' signing key

  • -y, --proof-type [JWT|LD_PROOF] Proof type to be used [LD_PROOF]

  • -p, --proof-purpose TEXT Proof purpose to be used [assertion]

  • --interactive Interactively prompt for VC data to fill in

  • --ld-signature, --ld-sig \[Ed25519Signature2018|Ed25519Signature2020|EcdsaSecp256k1Signature2019|RsaSignature2018|JsonWebSignature2020|JcsEd25519Signature2020]

  • --ecosystem \[DEFAULT|ESSIF|GAIAX|IOTA] Specify ecosystem, for specific defaults of issuing parameters

  • --statusType \[StatusList2021Entry|SimpleCredentialStatus2022] specify the credentialStatus type

e.g.

  • vc issue -t OpenBadgeCredential -s did:key:z6MkpuUYdpaZPcpnEWnkE8vb7s2u2geTZJden1BwGXsdFUz3 -i did:ebsi:zZ5apnsHPUXNqjWELjNZhYW, returns a credential document (JSON format)

Present VC

Use present command to present a VC or VP to a verifier.

-i, --holder-did TEXT DID of the holder (owner of the VC)

-v, --verifier-did TEXT DID of the verifier (recipient of the VP)

-d, --domain TEXT Domain name to be used in the LD proof

-c, --challenge TEXT Challenge to be used in the LD proof

Verify VC or VP

use verify command to verify

-p, --policy VALUE Verification policy. Can be specified multiple times. By default, SignaturePolicy is used. For more details on how to specify the policies, refer to Verification Policies.

List verification policies

To see available verification policies, use vc policies command

Import VC to custodian store

Import VC to custodian store

VC templates

Learn about VC template related functions like the listing and exporting of templates, as well as how to create/import your own custom VC template.

List VC templates in custodian store

  • list List VC Templates.

vc template list result

Export VC template from custodian store

  • export <template-name> Export VC Template.

Options:

  • -n, --name <Name> Name of the template

e.g. vc templates export --name VerifiableId

Import VC template to custodian store

  • import <customCredentialPath.json>

Options:

  • -n, --name <Name> Name of the template

Arguments:

  • credential path the last argument of the command references the path to the custom credential, which should be imported

e.g vc templates import -n MyCustomCredential custom.json

custom.json

{
  "type": [
    "VerifiableCredential",
    "MyCustomCredential" // name of the credential
  ],
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    "https://www.w3.org/2018/credentials/examples/v1"
  ],
  "id": "http://example.gov/credentials/3732",
  "issuer": {
    "id": "did:example:456"
  },
  "issued": "2020-03-10T04:24:12.164Z",
  "credentialSubject": { //custom credential subject
    "id": "",
    "firstName": "",
    "lastName": "",
    "country": "Austria"
  }
}

Output of the command

List VCs

  • list VCs saved in the custodian store

e.g. vc list

-t, --template TEXT specify the VC template. To create your own template, have a look [Required]

here
intro section
Issues and save VC
Present VC
Verify VC or VP
List verification policies
Import VC to custodian store
VC templates
List VCs