Skip to main content

IssuanceRequestInput

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

The following example demonstrates an issuance request by using a PIN code flow with user claims, such as first name and last name.

{
  "contractId": "01910769-c6e8-7d2a-9ecd-1f2bcb7f62ba"
  "identityId": "8ae15985-0d43-40f8-a52e-b51399a0de12"
  "includeQRCode": true,
  "claims": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "pin": {
    "value": "1234"
  }
}

The result of this request returns a URL and optional QR code to start the issuance process.

input IssuanceRequestInput {
  callback: Callback
  claims: JSONObject
  contractId: ID!
  expirationDate: DateTime
  faceCheckPhoto: String
  identity: IdentityInput
  identityId: ID
  includeQRCode: Boolean
  photoCaptureRequestId: ID
  pin: Pin
}

Fields​

IssuanceRequestInput.callback ● Callback input​

The callback to register.

IssuanceRequestInput.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.

IssuanceRequestInput.contractId ● ID! non-null scalar​

The ID of the contract you wish to issue.

IssuanceRequestInput.expirationDate ● DateTime scalar​

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

Item of note:

  • The date must be in ISO format.

IssuanceRequestInput.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 image content type and encoding must be: image/jpg;base64.
  • Image data can only be provided by a single source, either from the faceCheckPhoto or the photoCaptureRequestId fields.
  • When the contract **requires** face check, either the **faceCheckPhoto** or the **photoCaptureRequestId** property must be set.
  • When the contract **requires no** face check, neither the **faceCheckPhoto** nor the **photoCaptureRequestId** property can be set.

IssuanceRequestInput.identity ● IdentityInput input​

The identity you wish to issue to.

Item of note:

  • _Optional:_ When issuing using a limited access token or the identityId property.

IssuanceRequestInput.identityId ● ID scalar​

The ID of the identity you wish to issue to.

Item of note:

  • _Optional:_ When issuing using a limited access token or the identity property.

IssuanceRequestInput.includeQRCode ● Boolean scalar​

A flag to specify whether a QR Code is included in the response of the request.

Items of note:

  • The Possible values are true (default) or false.
  • Present the QR code and ask the user to scan it.
  • Scanning the QR code launches the authenticator app with this issuance request.
  • When not using the QR Code, use the return url property to render a deep link.

IssuanceRequestInput.photoCaptureRequestId ● ID scalar​

The ID of the photo capture request.

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 photoCaptureRequestId fields.
  • When the contract **requires** face check, either the **faceCheckPhoto** or the **photoCaptureRequestId** property must be set.
  • When the contract **requires no** face check, neither the **faceCheckPhoto** nor the **photoCaptureRequestId** property can be set.
  • A photo capture request is only valid for a single issuance.

IssuanceRequestInput.pin ● Pin input​

The PIN code required for the issuance.

Item of note:

  • _Optional:_ When no PIN is set, the issuance process does not require a PIN.

Member Of​

createIssuanceRequest mutation