Skip to main content

Presentation definition

After a wallet connects to a verifier's request for proof via handle invitation, presentation definition takes the resulting proofId and filters the wallet, returning credentials which match the verifier's request.

Function

getPresentationDefinition(
proofId: ProofDetail["id"]
): Promise<PresentationDefinition>

Parameters

Return value

export interface PresentationDefinition {
requestGroups: PresentationDefinitionRequestGroup[];
}
export interface PresentationDefinitionRequestGroup {
id: string;
name?: string | null;
purpose?: string | null;
rule: PresentationDefinitionRule;
requestedCredentials: PresentationDefinitionRequestedCredential[];
}

Fields

  • name - Verifier can optionally submit name.

  • purpose - Verifier can optionally submit purpose of request.

  • rule - Specifies whether the verifier requires all of the requested credentials or some subset from which the holder can choose.

  • requestedCredentials - Summary of the credentials requested by the verifier. Includes suitable credentials filtered from the wallet (applicableCredentials).