API Reference

This page contains the complete auto-generated API reference for the Verifier SDK. The API is organized by the role of each component.

Core Components

The primary entry points for creating and using the SDK.

Factory Functions

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / createCredentialVerifier

Function: createCredentialVerifier()

createCredentialVerifier<Handlers>(options): CredentialVerifier

Defined in: packages/verifier/src/credential-verifier.ts:142

Type Parameters

Handlers

Handlers extends readonly link:../interfaces/VerificationHandler.md<Record<string, unknown>>[] = link:../interfaces/VerificationHandler.md<Record<string, unknown>>[]

Parameters

options

CredentialVerifierOptions & object

Returns

CredentialVerifier

Core Interfaces

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / CredentialVerifier

Interface: CredentialVerifier

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:60

Methods

createRequest()

createRequest(options): Promise<link:PresentationRequest.md>

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:67

Creates a presentation request.

Parameters

======= options

CredentialVerifierCreateRequestOptions

The options for creating the presentation request.

Returns

Promise<link:PresentationRequest.md>

A promise that resolves to the presentation request.

verify()

verify(presentation, request, handlerOptions?): Promise<link:VerificationResult.md<undefined>>

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:79

Verifies a presentation.

Parameters

======= presentation

unknown

The presentation to verify.

======= request

PresentationRequest

The presentation request.

======= handlerOptions?

Omit<VerificationHandlerOptions, "request" | "logger">

Optional handler-specific options (request and logger are provided automatically).

Returns

Promise<link:VerificationResult.md<undefined>>

A promise that resolves to the verification result.

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / VerificationHandler

Interface: VerificationHandler<Result>

Defined in: packages/verifier/src/interfaces/verification-handler.ts:40

Interface for a verification handler.

Type Parameters

Result

Result extends object = Record<string, unknown>

Methods

canHandle()

canHandle(input): boolean

Defined in: packages/verifier/src/interfaces/verification-handler.ts:48

Verifies if the input is a valid input for the handler.

Parameters

======= input

unknown

The input to verify.

Returns

boolean

True if the input is a valid input for the handler.

verify()

verify(input, options?): link:../type-aliases/HandlerResult.md<Result> | Promise<link:../type-aliases/HandlerResult.md<Result>>

Defined in: packages/verifier/src/interfaces/verification-handler.ts:56

Verifies the input and returns the result.

Parameters

======= input

unknown

The input to verify.

======= options?

VerificationHandlerOptions

The options for the handler.

Returns

link:../type-aliases/HandlerResult.md<Result> | Promise<link:../type-aliases/HandlerResult.md<Result>>

The result of the verification.

Handlers

Handlers are responsible for verifying credentials in a specific format (e.g., LDP, JWT).

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / VerificationHandler

Interface: VerificationHandler<Result>

Defined in: packages/verifier/src/interfaces/verification-handler.ts:40

Interface for a verification handler.

Type Parameters

Result

Result extends object = Record<string, unknown>

Methods

canHandle()

canHandle(input): boolean

Defined in: packages/verifier/src/interfaces/verification-handler.ts:48

Verifies if the input is a valid input for the handler.

Parameters

======= input

unknown

The input to verify.

Returns

boolean

True if the input is a valid input for the handler.

verify()

verify(input, options?): link:../type-aliases/HandlerResult.md<Result> | Promise<link:../type-aliases/HandlerResult.md<Result>>

Defined in: packages/verifier/src/interfaces/verification-handler.ts:56

Verifies the input and returns the result.

Parameters

======= input

unknown

The input to verify.

======= options?

VerificationHandlerOptions

The options for the handler.

Returns

link:../type-aliases/HandlerResult.md<Result> | Promise<link:../type-aliases/HandlerResult.md<Result>>

The result of the verification.

Policies

Policies are reusable classes that enforce business rules on the credential claims during verification.

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / CredentialPolicy

Interface: CredentialPolicy<PolicyData, ResultData>

Defined in: packages/verifier/src/interfaces/credential-policy.ts:43

Type Parameters

PolicyData

PolicyData extends object = Record<string, unknown>

ResultData

ResultData extends object = undefined

Properties

DESCRIPTION?

optional DESCRIPTION?: string

Defined in: packages/verifier/src/interfaces/credential-policy.ts:55

Optional description of the policy.

NAME

NAME: string

Defined in: packages/verifier/src/interfaces/credential-policy.ts:50

The unique name of the policy that will be used to identify the policy.

Methods

execute()

execute(input): link:PolicyResult.md<ResultData> | Promise<link:PolicyResult.md<ResultData>>

Defined in: packages/verifier/src/interfaces/credential-policy.ts:68

Logic to verify the policy compliance against the given credential.

Parameters

======= input

link:PolicyInput.md<PolicyData>

The policy input containing the credential data and request.

Returns

link:PolicyResult.md<ResultData> | Promise<link:PolicyResult.md<ResultData>>

A promise that resolves to the policy result.

getCredentialConstraints()?

optional getCredentialConstraints(): object | Promise<object>

Defined in: packages/verifier/src/interfaces/credential-policy.ts:60

Returns the credential constraints for the policy.

Returns

object | Promise<object>

Type Definitions

These interfaces define the shape of the data structures used throughout the SDK, such as requests, results, and options.

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / CredentialVerifierOptions

Interface: CredentialVerifierOptions

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:36

Properties

handlers

handlers: link:VerificationHandler.md<Record<string, unknown>>[]

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:40

The handlers that will be used to handle credential formats.

logger?

optional logger?: Logger

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:50

The logger to be used by the verifier to log messages.

policies

policies: link:CredentialPolicy.md<Record<string, unknown>, undefined>[]

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:45

The policies that will be used to verify the presentation.

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / VerificationInput

Type Alias: VerificationInput

VerificationInput = unknown

Defined in: packages/verifier/src/interfaces/verification-input.ts:1

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / VerificationResult

Interface: VerificationResult<ResultData>

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:24

Type Parameters

ResultData

ResultData extends object = undefined

Properties

policyResults?

optional policyResults?: Record<string, link:PolicyResult.md<ResultData>>

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:33

The results of the policies that were used to verify the presentation.

verified

verified: true

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:28

Whether the presentation is verified or not.

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / PresentationRequest

Interface: PresentationRequest

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:7

Properties

credentials

credentials: unknown[]

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:21

The credentials that will be used to verify the presentation.

id

id: string

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:11

The unique identifier of the presentation request.

policies

policies: string[]

Defined in: packages/verifier/src/interfaces/credential-verifier.ts:16

The names of the policies that will be used to verify the presentation.

@the-hashgraph-group-ag/verifier

@the-hashgraph-group-ag/verifier / HandlerResult

Type Alias: HandlerResult<Result>

HandlerResult<Result> = object

Defined in: packages/verifier/src/interfaces/verification-handler.ts:9

Interface for the result of a verification handler.

Type Parameters

Result

Result extends object = Record<string, unknown>

Properties

data

data: Result

Defined in: packages/verifier/src/interfaces/verification-handler.ts:10