Structs

AssertionProof, typically used to ensure authenticity and integrity of a verifiable credential

Contains information necessary to make on-chain transactions (e.g. updating a DID Document).

A verifiable credential issued by an issuer upon receiving a CredentialRequest. Specifies the signed values, the DID of the prover/subject, the CredentialSchema, and the CredentialSignature including revocation info.

Message following a CredentialProposal, sent by an issuer. Specifies the DIDs of both the CredentialSchema and CredentialDefinition to be used for issuance.

Message following a BbsCredentialOffer, sent by a potential credential prover. Provides the values that need to be signed by the issuer in both encoded/cleartext, and blinded format. Incorporates the nonce value sent in BbsCredentialOffer.

The signature (‘proof’ part) of a BBS+ verifiable credential.

A verifiable credential exposing requested properties of a BbsCredential by providing a Bbs signature proof

A proof object of a BbsPresentation

Message sent by a verifier stating which attributes of which schema the prover is supposed to reveal.

Result of a call to the verifyProof endpoint. Gives the status of a verification (i.e. whether it was successful or not) and a reason, if rejected.

Part of a proof request that requests attributes of a specific schema

API payload to create a credential proposal to be sent by a holder.

API payload needed to create a credential schema needed for issuing credentials

API payload to create new BBS+ keys and persist them on the DID document.

API payload needed to create a revocation list

Message to initiate credential issuance, sent by (potential) prover. Specifies the schema to be used for the credential.

Specifies the properties of a credential, as well as metadata. Needs to be stored publicly available and temper-proof.

Reference to a credential schema.

‘credentialStatus’ property of a verifiable credential containing revocation information.

Payload/data part of a verifiable credential.

API payload for finishing a UnfinishedBbsCredential as a holder.

API payload for issuing a new credential Currently needs both an unsigned verifiable credential containing all the data and the nquad representation of this verifiable credential.

API payload for creating a BbsCredentialOffer to be sent by an issuer. Contains information about how many messages the final credential will hold.

API payload for creating a zero-knowledge proof out of a BBS+ signature.

A collection of all proofs requested in a ProofRequest. Sent to a verifier as the response to a ProofRequest.

API payload to create a credential request to be sent by a holder as a response to a BbsCredentialOffer.

API payload to create a BbsProofRequest to be sent by a verifier.

A revocation list credential associating verifiable credential revocation IDs to their revocation status as a bit list. See https://w3c-ccg.github.io/vc-status-rl-2020/#revocationlist2020credential

Payload part of a revocation list credential.

API payload to revoke a credential as this credential’s issuer.

Metadata about a property of a credential schema

Message passed to vade containing the desired credential type. Does not perform action if type does not indicate credential type BBS+. This can be done by passing “bbs” as the value for “type”.

A verifiable credential containing a blind signature that still needs to be processed by the holder/receiver.

A blinded signature created by an issuer that needs to be finished by the holder/receiver of this signature.

Proof presentation without a proof (just for internal use)

RevocationListCredential without a proof (for internal use only).

A verifiable credential with a blind signature that still needs to be processed by the holder

API payload for verifying a received proof as a verifer.

Constants