Bedrock VC Verifier API module (@bedrock/vc-verifier)

A VC Verifier API library for use with Bedrock applications.

Table of Contents

• Background
• Security
• Install
• Usage
• Contribute
• Commercial Support
• License

Background

• Verifiable Credentials HTTP API v0.3 specification.

Security

TBD

Install

This software requires and supports maintained recent versions of Node.js. Updates may remove support for older unmaintained platform versions. Please use dependency version lock files and testing to ensure compatibility with this software.

NPM

To install via NPM:

npm install --save @bedrock/vc-verifier

Development

To install locally (for development):

git clone https://github.com/digitalbazaar/bedrock-vc-verifier.git
cd bedrock-vc-verifier
npm install

Usage

In lib/index.js:

import '@bedrock/vc-verifier';

Verifier HTTP API

This module exposes the following API endpoints.

Verify Presentation - POST /vc/verify

Example request:

{
  "presentation": {},
  "challenge": "...",
  "domain": "issuer.example.com"
}

Verify Credentials - POST /verifier/credentials

Alias: /instances/:instanceId/credentials/verify

Optionally performs status checks using the @digitalbazaar/vc-revocation-list or @digitalbazaar/vc-status-list library.

Example request:

{
  "verifiableCredential": {},
  "options": {
    "checks": ["proof", "credentialStatus"]
  }
}

Verify Presentations - POST /verifier/presentations

Alias: /instances/:instanceId/presentations/verify

Optionally performs status checks using the vc-revocation-list or vc-status-list library.

Example request:

{
  "verifiablePresentation": {},
  "options": {
    "challenge": "...",
    "checks": ["proof", "credentialStatus"],
    "domain": "issuer.exmaple.com"
  }
}

Contribute

See the contribute file!

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: support@digitalbazaar.com

License

Bedrock Non-Commercial License v1.0 © Digital Bazaar