Contract

Defines a contract that can be used to issue credentials

type Contract {
  asyncIssuanceRequests(
    limit: PositiveInt = 100
    offset: PositiveInt
    where: ContractAsyncIssuanceRequestsWhere
  ): [AsyncIssuanceRequest!]!
  createdAt: DateTime!
  createdBy: User!
  credentialTypes: [String!]!
  deprecatedAt: DateTime
  deprecatedBy: User
  description: String! @deprecated
  display: ContractDisplayModel!
  externalId: String
  faceCheckSupport: FaceCheckPhotoSupport!
  id: ID!
  isDeprecated: Boolean
  isPublic: Boolean!
  issuanceCount: Int!
  issuanceWeeklyAverage(
    where: ContractIssuanceWeeklyAverageWhere!
  ): Float!
  issuances(
    limit: PositiveInt = 100
    offset: PositiveInt
    where: ContractIssuanceWhere
  ): [Issuance!]!
  lastProvisionedAt: DateTime
  lastProvisionedBy: User
  name: String!
  presentationWeeklyAverage(
    where: ContractPresentationWeeklyAverageWhere!
  ): Float!
  presentations(
    limit: PositiveInt = 100
    offset: PositiveInt
    where: ContractPresentationWhere
  ): [Presentation!]!
  provisionedAt: DateTime
  provisionedBy: User
  template: Template
  templateData: TemplateParentData
  updatedAt: DateTime
  updatedBy: User
  validityIntervalInSeconds: PositiveInt!
}

Fields

Contract.asyncIssuanceRequests ● [AsyncIssuanceRequest!]! non-null object

Returns the async issuance requests for this contract, optionally matching the specified criteria.

Contract.asyncIssuanceRequests.limit ● PositiveInt scalar

Contract.asyncIssuanceRequests.offset ● PositiveInt scalar

Contract.asyncIssuanceRequests.where ● ContractAsyncIssuanceRequestsWhere input

Contract.createdAt ● DateTime! non-null scalar

When the contract was created.

Contract.createdBy ● User! non-null object

The user who created the contract.

Contract.credentialTypes ● [String!]! non-null scalar

The type(s) of the contract / credential Requires at least one type, and cannot have duplicate types

Contract.deprecatedAt ● DateTime scalar

When the contract was deprecated.

Contract.deprecatedBy ● User object

Who deprecated the contract.

Contract.description ● String! deprecated non-null scalar

DEPRECATED

no longer in use

The description of the contract

Contract.display ● ContractDisplayModel! non-null object

The full or partial credential display definition defined by this contract

Contract.externalId ● String scalar

The ID of the contract in the Verified ID service. This only has a value when the contract has been provisioned.

Contract.faceCheckSupport ● FaceCheckPhotoSupport! non-null enum

The type of face check photo support

Contract.id ● ID! non-null scalar

The unique identifier for the contract

Contract.isDeprecated ● Boolean scalar

Defines whether the contract is deprecated, if so no new issuance can be requested for it

Contract.isPublic ● Boolean! non-null scalar

Defines whether the contracts created from this template will be published in the Verified Credentials Network

Contract.issuanceCount ● Int! non-null scalar

Returns the total number of credential issuances for this contract.

Contract.issuanceWeeklyAverage ● Float! non-null scalar

Returns the weekly average of credential issuances for this contract.

Contract.issuanceWeeklyAverage.where ● ContractIssuanceWeeklyAverageWhere! non-null input

Contract.issuances ● [Issuance!]! non-null object

Returns the successful credential issuances for this contract.

Contract.issuances.limit ● PositiveInt scalar

Contract.issuances.offset ● PositiveInt scalar

Contract.issuances.where ● ContractIssuanceWhere input

Contract.lastProvisionedAt ● DateTime scalar

When the contract was last provisioned in the Verified ID service.

Contract.lastProvisionedBy ● User object

Who last provisioned the contract in the Verified ID service.

Contract.name ● String! non-null scalar

The name of the contract

Contract.presentationWeeklyAverage ● Float! non-null scalar

Returns the weekly average of credential presentations for this contract.

Contract.presentationWeeklyAverage.where ● ContractPresentationWeeklyAverageWhere! non-null input

Contract.presentations ● [Presentation!]! non-null object

Returns the successful credential presentations for this contract.

Contract.presentations.limit ● PositiveInt scalar

Contract.presentations.offset ● PositiveInt scalar

Contract.presentations.where ● ContractPresentationWhere input

Contract.provisionedAt ● DateTime scalar

When the contract was initially provisioned in the Verified ID service.

Contract.provisionedBy ● User object

Who initially provisioned the contract in the Verified ID service.

Contract.template ● Template object

The template that this contract is based on

Contract.templateData ● TemplateParentData object

The combined representation of the template's parent chain.

Contract.updatedAt ● DateTime scalar

When the contract was last updated.

Contract.updatedBy ● User object

The user who last updated the contract.

Contract.validityIntervalInSeconds ● PositiveInt! non-null scalar

The lifespan of the credential expressed in seconds

Returned By

contract query ● createContract mutation ● deprecateContract mutation ● findContracts query ● provisionContract mutation ● updateContract mutation

Member Of

AsyncIssuanceRequest object ● ContractCount object ● Issuance object ● Template object