Skip to main content

AsyncIssuanceRequest

The async issuance request.

type AsyncIssuanceRequest {
  communications(
    limit: PositiveInt
    offset: PositiveInt
    orderBy: CommunicationOrderBy
    orderDirection: OrderDirection
    where: CommunicationWhere
  ): [Communication!]!
  contract: Contract!
  createdAt: DateTime!
  createdBy: User!
  expiresOn: DateTime!
  expiry: AsyncIssuanceRequestExpiry!
  failureReason: String
  hasContactNotificationSet: Boolean
  hasContactVerificationSet: Boolean
  id: ID!
  identity: Identity!
  isStatusFinal: Boolean!
  issuance: Issuance
  photoCapture: Boolean
  status: AsyncIssuanceRequestStatus!
  updatedAt: DateTime
  updatedBy: User
}

Fields​

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

The communications that have been sent for this async issuance request.

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

AsyncIssuanceRequest.contract ● Contract! non-null object​

The contract to be issued.

AsyncIssuanceRequest.createdAt ● DateTime! non-null scalar​

When the async issuance request was created.

AsyncIssuanceRequest.createdBy ● User! non-null object​

The user who created the async issuance request.

AsyncIssuanceRequest.expiresOn ● DateTime! non-null scalar​

The point in the future which the issuees can no longer complete the issuance process.

Items of note:

  • The period started upon receipt of the request.

AsyncIssuanceRequest.expiry ● AsyncIssuanceRequestExpiry! non-null enum​

The expiry setting for this async issuance request.

AsyncIssuanceRequest.failureReason ● String scalar​

When set, the reason this async issuance request failed to issue.

Items to note:

  • The reason is only available when the status is failed.

AsyncIssuanceRequest.hasContactNotificationSet ● Boolean scalar​

Indicates whether this async issuance request has contact notification details set, indicating whether issuance notifications will be sent.

Items of note:

  • This field will only return a value while the issuance is pending.
  • This field value is derived from contact data, therefore is relatively expensive to query and can only be queried for single async issuance request at a time.

AsyncIssuanceRequest.hasContactVerificationSet ● Boolean scalar​

Indicates whether this async issuance request has contact verification details set, indicating whether issuance via OTP verification is supported.

Items of note:

  • This field will only return a value while the issuance is pending.
  • This field value is derived from contact data, therefore is relatively expensive to query and can only be queried for single async issuance request at a time.

AsyncIssuanceRequest.id ● ID! non-null scalar​

The ID of the async issuance request.

AsyncIssuanceRequest.identity ● Identity! non-null object​

The issuee identity

AsyncIssuanceRequest.isStatusFinal ● Boolean! non-null scalar​

A flag indicating if the status of the async issuance request is final.

Items to note:

  • When set to true, the status will not change and no further actions can be taken on the async issuance request.

AsyncIssuanceRequest.issuance ● Issuance object​

The issuance.

Items of note:

  • When not set, the issuance has not been successfully claimed by the issuee.

AsyncIssuanceRequest.photoCapture ● Boolean scalar​

When set to true, the issuee is required to capture their photo during the issuance process.

Items of note:

  • This field will only return a value while the issuance is pending.
  • This field value is derived from contact data, therefore is relatively expensive to query and can only be queried for single async issuance request at a time.

AsyncIssuanceRequest.status ● AsyncIssuanceRequestStatus! non-null enum​

The status of the async issuance request.

AsyncIssuanceRequest.updatedAt ● DateTime scalar​

When the async issuance request was last updated.

AsyncIssuanceRequest.updatedBy ● User object​

The user who last updated the async issuance request.

Returned By​

asyncIssuanceRequest query ● cancelAsyncIssuanceRequest mutation ● findAsyncIssuanceRequests query ● resendAsyncIssuanceNotification mutation

Member Of​

Contract object ● Identity object