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
- React Native
- iOS
- Android
getPresentationDefinition(
proofId: ProofDetail["id"]
): Promise<PresentationDefinition>
func getPresentationDefintion(proofId: String) throws -> PresentationDefinitionBindingDto
fun `getPresentationDefinition`(`proofId`: String): PresentationDefinitionBindingDto
Parameters
proofId
- ID of the proof request; value from handle invitation.
Return value
- React Native
- iOS
- Android
export interface PresentationDefinition {
requestGroups: PresentationDefinitionRequestGroup[];
}
export interface PresentationDefinitionRequestGroup {
id: string;
name?: string | null;
purpose?: string | null;
rule: PresentationDefinitionRule;
requestedCredentials: PresentationDefinitionRequestedCredential[];
}
public struct PresentationDefinitionBindingDto {
public var requestGroups: [PresentationDefinitionRequestGroupBindingDto]
}
public struct PresentationDefinitionRequestGroupBindingDto {
public var id: String
public var name: String?
public var purpose: String?
public var rule: PresentationDefinitionRuleBindingDto
public var requestedCredentials: [PresentationDefinitionRequestedCredentialBindingDto]
}
data class PresentationDefinitionBindingDto (
var `requestGroups`: List<PresentationDefinitionRequestGroupBindingDto>
)
data class PresentationDefinitionRequestGroupBindingDto (
var `id`: String,
var `name`: String?,
var `purpose`: String?,
var `rule`: PresentationDefinitionRuleBindingDto,
var `requestedCredentials`: List<PresentationDefinitionRequestedCredentialBindingDto>
)
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
).