Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: OverlaysCaptureBundle #15

Open
bj-ms opened this issue Jun 28, 2024 · 1 comment
Open

Proposal: OverlaysCaptureBundle #15

bj-ms opened this issue Jun 28, 2024 · 1 comment

Comments

@bj-ms
Copy link

bj-ms commented Jun 28, 2024

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.

@PatStLouis
Copy link
Collaborator

big +1, @bj-ms and I will be collaborating on this!

@bj-ms bj-ms changed the title Proposal: OverlaysCaptureArchitecture Proposal: OverlaysCaptureBundle Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants