Proposal: OverlaysCaptureBundle

In our current use case, we want to include a URL to an OCA bundle. The OCA contains the metadata we need to render a VC correctly.

We would like to propose the following chapter to specify the type OverlaysCaptureBundle:

OverlaysCaptureBundle

When an issuer desires to specify OCA rendering instructions for a verifiable credential, they MAY add a render property that uses the data model described below.

Property | Description -- | -- id | A URL that dereferences to an OCA bundle with an associated application/json media type. The last URL path segment must be the OCA bundle filename which is the CESR encoded digest of the file's content. type | The type property MUST be OverlaysCaptureBundle.

The data model shown above is expressed in a verifiable credential in the example below.

EXAMPLE 1: Usage of the render property by an issuer

{
  "@context": [
    "https://www.w3.org/ns/credentials/v2",
    "https://w3id.org/vc/render-method/v1"
  ],
  "id": "http://example.com/credentials/3732",
  "type": ["VerifiableCredential"],
  "issuer": "https://example.com/issuers/14",
  "validFrom": "2010-01-01T19:23:24Z",
  "credentialSubject": {
    "id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
    "firstname": "John",
    "lastname": "Smith"
  },
  "renderMethod": [{
    "id": "https://example.com/oca/IEY2Sow9DYS8cSAUN3ot95BRMVxzlCrwtkqBdpZE1kI8.json",
    "type": "OverlaysCaptureBundle"
  }]
  
}

In the example above, the issuer has provided an OCA bundle rendering description for a personal ID that will be used to describe the content and the visual representation of the verifiable credential.

w3c-ccg / vc-render-method

Proposal: OverlaysCaptureBundle #15