w3c / w3c/vc-render-method

Proposal: OverlaysCaptureBundle

Open
#15 3 comments 0 reactions 1 assignee View on GitHub

@PatStLouis is already working on this.

Since May 31, 2025.

Dominant language
HTML
Stars
9
Forks
8
Avg merge
14d 42m
Merged PRs (30d)
2

Description

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": "OverlaysCaptureBundleV1" }] }

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.