Skip to main content

PresentationFlow

A presentation flow.

type PresentationFlow {
action: Action
actions: [Action!]
autoSubmit: Boolean
communications(
limit: PositiveInt
offset: NonNegativeInt
orderBy: CommunicationOrderBy
orderDirection: OrderDirection
where: CommunicationWhere
): [Communication!]!
createdAt: DateTime!
createdBy: User!
dataResults: JSONObject
dataSchema: [DataDefinition!]
expiresAt: DateTime!
hasContactNotificationSet: Boolean!
id: ID!
identity: Identity
isCancelled: Boolean
isSubmitted: Boolean
notificationStatus: PresentationFlowNotificationStatus
portalUrl: String!
postPresentationText: Markdown
prePresentationText: Markdown
presentation: Presentation
presentationRequest: JSONObject
requestData: JSONObject
requestUrl: String
source: PresentationFlowSource!
status: PresentationFlowStatus!
template: PresentationFlowTemplate
title: String
type: String!
updatedAt: DateTime
updatedBy: User
}

Fields​

PresentationFlow.action ● Action object​

PresentationFlow.actions ● [Action!] list object​

PresentationFlow.autoSubmit ● Boolean scalar​

PresentationFlow.communications ● [Communication!]! non-null object​

The communications that have been sent for this presentation flow.

PresentationFlow.communications.limit ● PositiveInt scalar​
PresentationFlow.communications.offset ● NonNegativeInt scalar​
PresentationFlow.communications.orderBy ● CommunicationOrderBy enum​
PresentationFlow.communications.orderDirection ● OrderDirection enum​
PresentationFlow.communications.where ● CommunicationWhere input​

PresentationFlow.createdAt ● DateTime! non-null scalar​

PresentationFlow.createdBy ● User! non-null object​

PresentationFlow.dataResults ● JSONObject scalar​

PresentationFlow.dataSchema ● [DataDefinition!] list object​

PresentationFlow.expiresAt ● DateTime! non-null scalar​

PresentationFlow.hasContactNotificationSet ● Boolean! non-null scalar​

Indicates whether this presentation flow has contact notification details set.

PresentationFlow.id ● ID! non-null scalar​

PresentationFlow.identity ● Identity object​

PresentationFlow.isCancelled ● Boolean scalar​

PresentationFlow.isSubmitted ● Boolean scalar​

PresentationFlow.notificationStatus ● PresentationFlowNotificationStatus enum​

The status of the notification for this presentation flow.

PresentationFlow.portalUrl ● String! non-null scalar​

PresentationFlow.postPresentationText ● Markdown scalar​

PresentationFlow.prePresentationText ● Markdown scalar​

PresentationFlow.presentation ● Presentation object​

PresentationFlow.presentationRequest ● JSONObject scalar​

PresentationFlow.requestData ● JSONObject scalar​

PresentationFlow.requestUrl ● String scalar​

The deep link (e.g. openid-vc://...) for the most recently created presentation request on this flow, if any. Callers can re-derive a QR code from this URL without needing to hold onto the original mutation response.

PresentationFlow.source ● PresentationFlowSource! non-null enum​

The origin of this presentation flow.

PresentationFlow.status ● PresentationFlowStatus! non-null enum​

PresentationFlow.template ● PresentationFlowTemplate object​

PresentationFlow.title ● String scalar​

PresentationFlow.type ● String! non-null scalar​

The type of this presentation flow — vc for a standard Verifiable Credential flow, mdoc for an ISO 18013-5 mDoc/Google Wallet ID flow.

PresentationFlow.updatedAt ● DateTime scalar​

PresentationFlow.updatedBy ● User object​

Returned By​

findPresentationFlows query ● presentationFlow query ● presentationFlowEvent subscription ● resendPresentationFlowNotification mutation ● submitPresentationFlowActions mutation ● updatePresentationFlowContact mutation

Member Of​

Identity object ● PresentationFlowResponse object ● QuickVerificationResponse object