Bedrock VC Verifier API module (bedrock-vc-verifier)
A VC Verifier API library for use with Bedrock applications.
Table of Contents
Background
- Verifiable Credentials HTTP API v0.3 specification.
Security
TBD
Install
- Node.js 12+ is required.
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
(or main.js
, as appropriate):
require('bedrock-vc-verifier');
Verifier HTTP API
This module exposes the following API endpoints.
POST /vc/verify
Verify Presentation - Example request:
{
"presentation": {},
"challenge": "...",
"domain": "issuer.exmaple.com"
}
POST /verifier/credentials
Verify Credentials - Alias: /instances/:instanceId/credentials/verify
Optionally performs status checks using the vc-revocation-list
or
vc-status-list
library.
Example request:
{
"verifiableCredential": {},
"options": {
"checks": ["proof", "credentialStatus"]
}
}
POST /verifier/presentations
Verify 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