Class and Flow diagram of the interactions

Interactions

Documentation

Welcome to the Sphereon SDK documentation

Welcome

Demo agent setup

OpenID Specifications for Verifiable Credentials (OID4VC)

Introduction

REST

Presentation Exchange v1 and v2 TypeScript Library

From V1 to V2

Development

Universal resolver registrar

Onboarding

Receiving Credentials from an Issuer

Sharing Credentials with a Verifier

Key Provider Service

The Signature Service allows you to create and verify signatures, as well as creating a hash/digest of input data

Signature Service

This library supports electronically signing PDF documents, including approval and certify signatures as well as visual signatures. Supported PDF signature types are:

PDF Signatures

The wellknown-dids-client is a library to create DID configuration resources and domain linkage credentials and to be able to verify these conforming to the DIF [spec for well-known DID Configurations](https://identity.foundation/.well-known/resources/did-configuration/)  It is written in Typescript and can be compiled to any target JavaScript version.

DIDs

Setup a typescript development environment

Setup development environment

Configure agent

OID4VCI Issuance exercises and explanation

Issuance exercises

OID4VP Presentation exercises and explanation

Presentation exercises

OID4VCI Credential design exercises and explanation

Credential design exercises

Status List exercises

Generate and return a new credential offer

Create credential offer

Check the current status of a credential issuance request

Get credential issuance status

Retrieve a specific credential offer by ID

Get credential offer

Returns the metadata about the credential issuer's capabilities, conforms to OID4VCI

Get credential issuer metadata

Get credential endpoint

Notification endpoint

Get authorization server metadata, if the integrated authorization server is enabled. Conforms to OAuth2

Authorization challenge endpoint in case a first party flow is enabled with the integrated authorization server

Issues an access token based on an authorization request, in case the integrated authorization server is enabled

Access token endpoint

Creates a new status list and returns its status list credential.

Create a new status list

Retrieve the status list credential for the given index. 
The response may be:
  - A signed JWT or SD-JWT string, for example, in the case of OAuth StatusLists.
  - A JSON-encoded Verifiable Credential, as per the W3C Verifiable Credential specification.


Get a status list credential. This is what a wallet or RP would call, as this value ends up in digital credentials

Retrieve the status details of a specific entry in a status list. This is mainly only use full for an issuer managing the status list. It should not be called by a RP or wallet

Get status list entry by ID

Retrieve the status of a specific index in the status list. This is usefull for an issuer managing the status list. It should not be used by a RP or wallet

Get status by index

Updates the status of a credential in the status list. This endpoint supports updates by `credentialId` or `statusListIndex`, along with optional parameters for `statusListId` or correlation IDs.

Get Started

SSI SDK

OID4VC

Status Lists

Presentation Exchange

W3C VC API

DIF Universal Resolver+Registrar

Mobile Wallet

eIDAS Advanced Electronic Signature Client

Well Known DID client

Interactions

Class and Flow diagram of the interactions

Get Started

SSI SDK

OID4VC

Status Lists

Presentation Exchange

W3C VC API

DIF Universal Resolver+Registrar

Mobile Wallet

eIDAS Advanced Electronic Signature Client

Well Known DID client

​Class and Flow diagram of the interactions

Class and Flow diagram of the interactions