Class VerifiablePresentation

constructor

• new VerifiablePresentation(vpDataModel): VerifiablePresentation

• Parameters

  • vpDataModel: IPresentation

  Returns VerifiablePresentation

vpDataModel

holder

• get holder(): string

• The holder of the Verifiable Presentation.

  Returns string

type

• get type(): string

• The type of the Verifiable Presentation.

  Returns string

verifiableCredential

• get verifiableCredential(): string[]

• The verifiable credentials contained in the Verifiable Presentation.

  Returns string[]

sign

• sign(options): Promise<string>

• Signs the verifiable presentation and returns it as a signed JWT.

  Parameters

  • options: VerifiablePresentationSignOptions

    The sign options used to sign the presentation.

  Returns Promise<string>

  The JWT representing the signed verifiable presentation.

  Example

  const vpJwt = verifiablePresentation.sign({ did: myDid });
  Copy

toString

• toString(): string

• Converts the current object to its JSON representation.

  Returns string

  The JSON representation of the object.

Static create

• create(options): Promise<VerifiablePresentation>

• Create a [VerifiablePresentation] based on the provided parameters.

  Parameters

  • options: VerifiablePresentationCreateOptions

    The options to use when creating the Verifiable Presentation.

  Returns Promise<VerifiablePresentation>

  A [VerifiablePresentation] instance.

  Example

  const vp = await VerifiablePresentation.create({
      type: 'PresentationSubmission',
      holder: 'did:ex:holder',
      vcJwts: vcJwts,
      additionalData: { 'arbitrary': 'data' }
    })
  Copy

Static parseJwt

• parseJwt(vpJwt): VerifiablePresentation

• Parses a JWT into a [VerifiablePresentation] instance.

  Parameters

  • vpJwt: {
        vpJwt: string;
    }

    The verifiable presentation JWT as a [String].

    • vpJwt: string

  Returns VerifiablePresentation

  A [VerifiablePresentation] instance derived from the JWT.

  Example

  const vp = VerifiablePresentation.parseJwt({ vpJwt: signedVpJwt })
  Copy

Static verify

• verify(vpJwt): Promise<{
      issuer: string;
      subject: string;
      vp: IPresentation;
  }>

• Verifies the integrity and authenticity of a Verifiable Presentation (VP) encoded as a JSON Web Token (JWT).

  This function performs several crucial validation steps to ensure the trustworthiness of the provided VP:

  • Parses and validates the structure of the JWT.
  • Ensures the presence of critical header elements alg and kid in the JWT header.
  • Resolves the Decentralized Identifier (DID) and retrieves the associated DID Document.
  • Validates the DID and establishes a set of valid verification method IDs.
  • Identifies the correct Verification Method from the DID Document based on the kid parameter.
  • Verifies the JWT's signature using the public key associated with the Verification Method.

  If any of these steps fail, the function will throw a [Error] with a message indicating the nature of the failure.

  Parameters

  • vpJwt: {
        vpJwt: string;
    }

    The Verifiable Presentation in JWT format as a [string].

    • vpJwt: string

  Returns Promise<{
      issuer: string;
      subject: string;
      vp: IPresentation;
  }>

  Example

  try {
      VerifiablePresentation.verify({ vpJwt: signedVpJwt })
      console.log("VC Verification successful!")
  } catch (e: Error) {
      console.log("VC Verification failed: ${e.message}")
  }
  Copy

  Throws

  Error if the verification fails at any step, providing a message with failure details.

  Throws

  Error if critical JWT header elements are absent.