Skip to content

Add proof chain and set documentation to credential issuance #503

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 30, 2025
Merged

Add proof chain and set documentation to credential issuance #503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8cbbb38
Add proof handling documentation to credential issuance.
bparth24 Jul 29, 2025
da559e6
Fix grammatical issues in the issue credential section.
TallTed Jul 29, 2025
2026200
Improve clarity and readability of existing proof scenarios.
dlongley Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion components/Credential.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,10 @@ components:
description: The subject
"proof":
type: object
description: An optional proof for credentials that are secured using proof sets or chains.
description: >
An optional proof or array of proofs for credentials that are secured using proof sets or chains.
When present, the issuer instance configuration determines how these existing proofs are processed
(appended to create proof sets/chains, or trigger an error).
oneOf:
- type: object
- type: array
Expand Down
32 changes: 26 additions & 6 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -902,13 +902,33 @@ <h4>Issue Credential</h4>
provided `credential`, the instance MUST attach all of these proofs in response to
a single call to the `/credentials/issue` endpoint.
</p>
<p>
<p>
If a provided `credential` already contains one or more proofs,
an issuing instance SHOULD append its proofs to the list of existing proofs
provided by the caller, converting a single proof value to an array of
proof values if necessary. An issuing instance MAY be configured to return an
error if `credential` values that contain existing `proof` values are provided.
</p>
the behavior is determined by the configuration of the issuer instance. An issuing
instance SHOULD be configured to handle existing proofs in one of the following ways:
</p>
<ul>
<li>
<strong>Proof Sets</strong>: Append new proofs to the list of existing proofs
provided by the caller, first converting any existing single proof to a list
if necessary. Here there is no binding to any existing proofs; the new proofs
exist in parallel with those previously provided by the caller.
</li>
<li>
<strong>Proof Chains</strong>: Append new proofs to create or extend an existing
proof chain. Here proofs are linked in a specific sequence, potentially using the
<code>previousProof</code> property to establish the chain relationship.
</li>
<li>
<strong>Error Handling</strong>: Return an error if <code>credential</code>
values that contain existing <code>proof</code> values are provided, when
the instance is configured to only accept credentials without existing proofs.
</li>
</ul>
<p>
The specific approach used depends on the configuration of the issuer instance and
the intended use case for the verifiable credential.
</p>
</section>

<section>
Expand Down