Skip to main content

AsyncIssuanceRequestInput

Represents the input required for creating an async issuance request.

input AsyncIssuanceRequestInput {
  callback: Callback
  claims: JSONObject
  contact: AsyncIssuanceContactInput
  contractId: UUID!
  expirationDate: DateTime
  expiry: AsyncIssuanceRequestExpiry!
  faceCheckPhoto: String
  identity: IdentityInput
  identityId: UUID
  photoCapture: Boolean
  postIssuanceRedirectUrl: URL
}

Fields​

AsyncIssuanceRequestInput.callback ● Callback input​

The callback to register.

AsyncIssuanceRequestInput.claims ● JSONObject scalar​

The collection of assertions made about the subject in the verifiable credential.

Item of note:

  • You must fulfill the contract claims definition. Review contract creation for more information.

AsyncIssuanceRequestInput.contact ● AsyncIssuanceContactInput input​

The issuee's contact information for notification and OTP verification. When not set, no issuance notification is sent and the issuance can *only* be redeemed by signing-in to the Concierge with an existing credential.

AsyncIssuanceRequestInput.contractId ● UUID! non-null scalar​

The ID of the contract you wish to issue.

AsyncIssuanceRequestInput.expirationDate ● DateTime scalar​

Setting the expiration data allows for explicitly control over credential expiry, regardless of when it is issued.

Items of note:

  • The date must be in ISO format.

AsyncIssuanceRequestInput.expiry ● AsyncIssuanceRequestExpiry! non-null enum​

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

Items to note:

  • The period starts upon receipt of the request.
  • No further issuances are possible once expired.
  • Data associated with a request is automatically removed upon issuance or expiry.

AsyncIssuanceRequestInput.faceCheckPhoto ● String scalar​

The issuee's photo for use with face check presentation verification.

Items of note:

  • _Optional:_ When no photo is set and the contract does not require one, the issuance process does not require a photo.
  • The photo is displayed via the authenticator app.
  • The photo must be encoded using the data URL format, and the base-64 encoded image must be of a JPEG type.
  • Image data can only be provided by a single source, either from the faceCheckPhoto or the photoCapture fields.
  • When the contract **requires** face check, either the **faceCheckPhoto** or the **photoCapture** property must be set.
  • When the contract **requires no** face check, neither the **faceCheckPhoto** nor the **photoCapture** property can be set.

AsyncIssuanceRequestInput.identity ● IdentityInput input​

The identity to issue to.

Items of note:

  • _Required_ When not using the identityId property

AsyncIssuanceRequestInput.identityId ● UUID scalar​

The ID of the identity to issue to.

Items of note:

  • _Required_ When not using the identity property.

AsyncIssuanceRequestInput.photoCapture ● Boolean scalar​

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

Items of note:

  • _Optional:_ When no photo capture is set and the contract does not require one, the issuance process does not require a photo.
  • The captured photo is displayed via the authenticator app.
  • Image data can only be provided by a single source, either from the faceCheckPhoto or the photoCapture fields.
  • When the contract **requires** face check, either the **faceCheckPhoto** or the **photoCapture** property must be set.
  • When the contract **requires no** face check, neither the **faceCheckPhoto** nor the **photoCapture** property can be set.

AsyncIssuanceRequestInput.postIssuanceRedirectUrl ● URL scalar​

The URL to redirect the issuee to after the issuance process is completed.

Items of note:

  • _Optional:_ When no redirect URL is set, the issuee will remain on the success page.

Member Of​

createAsyncIssuanceRequest mutation