summary.vc.md

1. Introduction: The Summary VC

The Summary VC (S-VC) is a temporary credential designed to roll-up a number of other Catena-X VCs into a compact form that will fit within HTTP header limits. This document specifies the Summary VC schema.

The following is an example Summary VC:

 {
  "@context": [
    "https://w3id.org/2023/catenax/credentials/summary/v1"
  ],
  "id": "<credential uid>",
  "type": [
    "VerifiableCredential",
    "SummaryCredential"
  ],
  "issuer": "<did:web:issuer>",
  "issuanceDate": "2023-06-02T12:00:00Z",
  "expirationDate": "2022-06-16T18:56:59Z",
  "credentialSubject": {
    "id": "<did:web:subject>",
    "holderIdentifier": "<BPN>",
    "items": [
      "MembershipCredential",
      "DismantlerCredential",
      "PcfCredential",
      "SustainabilityCredential",
      "QualityCredential",
      "TraceabilityCredential",
      "BehaviorTwinCredential",
      "BpnCredential"
    ],
    "contractTemplates": "https://public.catena-x.org/contracts/"
  }
}

A Json-Ld context defining Summary VC terms is here

2. Verifiable Credential Properties

2.1. Credential Subject and Credential Holder

The credential subject and credential holder must be the same as described by the Verifiable Credentials Data Model v1.1.

• The mandatory id property of the credentialSubject object must be set to the subject's DID (did:web).
• The mandatory holderIdentifier property of the credentialSubject object must be set to the subject's BPN.

2.2 Summary Items

The mandatory items property defined by the https://w3id.org/2023/catenax/credentials/summary/v1 context contains a set of string identifiers indicating the credential types held by the subject.

Valid items are:

• MembershipCredential
• DismantlerCredential
• PcfCredential
• SustainabilityCredential
• QualityCredential
• TraceabilityCredential
• BehaviorTwinCredential
• BpnCredential

2.3 Mandatory Properties

If mandatory properties are not present, the VC should be interpreted as invalid.

3. Known Issues

The following are known questions and issues that need to be resolved with respect to other VCs for the 3.3 released. There is a proposed context that resolves these issues for the summary credential if it is decided not to retire that VC. Note that these issues will not be resolved for the 3.3 release.

3.1 Consistent Naming

• The credentialSubject#items property is too ambiguous and should be something like credentialSubject#hasCredentials
• The credentialSubject#contract-template property uses hyphens and should be consistent with W3C camelCase
• The credentialSubject#items-template property uses hyphens and should be consistent with W3C camelCase

3.2 Use of IRIs

The credentialSubject#contract-template property should be an IRI instead of text. There it should be defined as type @id:

{
  "contractTemplate": {
    "@id": "summary:contractTemplate",
    "@type": "@id"
  }
}