Skip to main content

PresentationRequestInput

The presentation request payload contains information about your verifiable credentials presentation request.

input PresentationRequestInput {
  callback: Callback
  identity: IdentityInput
  identityId: ID
  includeQRCode: Boolean
  includeReceipt: Boolean
  registration: PresentationRequestRegistration!
  requestedCredentials: [RequestCredential!]!
}

Fields​

PresentationRequestInput.callback ● Callback input​

PresentationRequestInput.identity ● IdentityInput input​

The identity who will present (alternatively use the identityId property, if known). Presentation identity information is only required for presentations where all requested credentials are issued by external partners.

PresentationRequestInput.identityId ● ID scalar​

The ID of the identity who will present (alternatively use the identity property). Presentation identity information is only required for presentations where all requested credentials are issued by external partners. When provided, a identityId constraint will be added to every requested credential.

PresentationRequestInput.includeQRCode ● Boolean scalar​

Determines whether a QR code is included in the response of this request. Present the QR code and ask the user to scan it. Scanning the QR code launches the authenticator app with this presentation request. Possible values are true (default) or false. When you set the value to false, use the return url property to render a deep link.

PresentationRequestInput.includeReceipt ● Boolean scalar​

Determines whether a receipt should be included in the response of this request. Possible values are true or false (default). The receipt contains the original payload sent from the authenticator to the Verifiable Credentials service. The receipt is useful for troubleshooting or if you have the need to get the full details of the payload. There's otherwise no need to set this value to true by default. In the OpenId Connect SIOP request, the receipt contains the ID token from the original request.

The receipt is internally redacted before being stored or logged to ensure sensitive values like vp_token and credential subjects are not persisted. Only selected fields such as id_token and faceCheck (if present) are retained.

PresentationRequestInput.registration ● PresentationRequestRegistration! non-null input​

PresentationRequestInput.requestedCredentials ● [RequestCredential!]! non-null input​

A collection of RequestCredential objects representing the credentials the user needs to provide.

Member Of​

createPresentationRequest mutation