Skip to content

Openid4vc #407

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

Draft
Milena-Czierlinski wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

Openid4vc #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ce1df1b
feat: add VerifiableCredential Attribute value type
Milena-Czierlinski Jun 2, 2026
9b908ed
feat: add ShareCredentialOfferRequestItem and ShareAuthorizationReque…
Milena-Czierlinski Jun 2, 2026
0f8d1a1
Merge branch 'main' into openid4vc
mergify[bot] Jun 11, 2026
144f907
Merge branch 'main' into openid4vc
mergify[bot] Jun 12, 2026
2abe418
Merge branch 'main' into openid4vc
mergify[bot] Jun 16, 2026
96ae976
Merge branch 'main' into openid4vc
mergify[bot] Jun 16, 2026
ede05fb
Merge branch 'main' into openid4vc
mergify[bot] Jun 23, 2026
a4d7a92
Merge branch 'main' into openid4vc
mergify[bot] Jun 24, 2026
a71bbb4
Merge branch 'main' into openid4vc
mergify[bot] Jun 24, 2026
57b97d6
Merge branch 'main' into openid4vc
mergify[bot] Jul 21, 2026
6654268
Merge branch 'main' into openid4vc
mergify[bot] Jul 22, 2026
93e0c5a
Merge branch 'main' into openid4vc
mergify[bot] Aug 7, 2026
09fdde3
Merge branch 'main' into openid4vc
mergify[bot] Aug 10, 2026
cc5a1fb
Merge branch 'main' into openid4vc
mergify[bot] Aug 11, 2026
ecb746e
Merge branch 'main' into openid4vc
mergify[bot] Aug 11, 2026
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
13 changes: 13 additions & 0 deletions _docs_integrate/attribute-values.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,19 @@ The Surname, also called family name or last name, is the portion of the persona
| `@type` | `"Surname"` | ✓ | |
| `value` | `string` | ✓ | max. length: 100 |

## VerifiableCredential

A VerifiableCredential is a set of information about an identity that follows the [W3C standard](https://www.w3.org/TR/vc-data-model-2.0/).

**Properties**

| Name | Type | Required | Validation |
| -------------------- | --------------------------------- | :------: | ------------------------------------------------- |
| `@type` | `"VerifiableCredential"` | ✓ | |
| `value` | `string` \| `Record<string, any>` | ✓ | max. size: 50MB<br>must be a valid string or JSON |
| `type` | `string` | ✗ | |
| `displayInformation` | `Record<string, any>` | ✗ | |

## Website

The website of the person which can be used to get more information about the person.
Expand Down
35 changes: 35 additions & 0 deletions _docs_integrate/data-model-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,6 +768,32 @@ Furthermore, all details on how to use the ShareAttributeRequestItem and example
| metadata | `object` \| `undefined` | The metadata property can be used to provide arbitrary JSON content by the sender of the Request. The metadata is not processed by enmeshed. It is a great way to use your own process descriptors at the time of sending the Request which helps you identify the correct internal process at the time of receiving the Response. |
| mustBeAccepted | `boolean` | The mandatory `mustBeAccepted` property is used to differentiate between required and optional RequestItems within the Request.<br>{::nomarkdown}<ul><li>If <code>mustBeAccepted</code> is set to <code>true</code>, the peer cannot <a href="{% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}">accept the Request</a> without accepting this RequestItem.</li><li>If <code>mustBeAccepted</code> is set to <code>false</code>, the peer can <a href="{% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}">accept the Request</a> even though the RequestItem is rejected.</ul>{:/} |

#### ShareAuthorizationRequestRequestItem

For more information you should check out the section [ShareAuthorizationRequestRequestItem of the Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}#shareauthorizationrequestrequestitem).
Furthermore, all details on how to use the ShareAttributeRequestItem and examples of use cases for it can be found in the [Share Attributes with peer]({% link _docs_integrate/share-attributes-with-peer.md %}) guide.

| Name | Type | Description |
| ----------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| @type | `"ShareAuthorizationRequestRequestItem"` | Specifies the type of the RequestItem for internal processing. |
| authorizationRequestUrl | `string` | The url that provides the authorization request. |
| description | `string` \| `undefined` | An optional, human readable description for the RequestItem. |
| metadata | `object` \| `undefined` | The metadata property can be used to provide arbitrary JSON content by the sender of the Request. The metadata is not processed by enmeshed. It is a great way to use your own process descriptors at the time of sending the Request which helps you identify the correct internal process at the time of receiving the Response. |
| mustBeAccepted | `boolean` | The mandatory `mustBeAccepted` property is used to differentiate between required and optional RequestItems within the Request.<br>{::nomarkdown}<ul><li>If <code>mustBeAccepted</code> is set to <code>true</code>, the peer cannot <a href="{% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}">accept the Request</a> without accepting this RequestItem.</li><li>If <code>mustBeAccepted</code> is set to <code>false</code>, the peer can <a href="{% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}">accept the Request</a> even though the RequestItem is rejected.</ul>{:/} |

#### ShareCredentialOfferRequestItem

For more information you should check out the section [ShareCredentialOfferRequestItem of the Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}#sharecredentialofferrequestitem).
Furthermore, all details on how to use the ShareAttributeRequestItem and examples of use cases for it can be found in the [Share Attributes with peer]({% link _docs_integrate/share-attributes-with-peer.md %}) guide.

| Name | Type | Description |
| ------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| @type | `"ShareCredentialOfferRequestItem"` | Specifies the type of the RequestItem for internal processing. |
| credentialOfferUrl | `string` | The url that provides the credential offer. |
| description | `string` \| `undefined` | An optional, human readable description for the RequestItem. |
| metadata | `object` \| `undefined` | The metadata property can be used to provide arbitrary JSON content by the sender of the Request. The metadata is not processed by enmeshed. It is a great way to use your own process descriptors at the time of sending the Request which helps you identify the correct internal process at the time of receiving the Response. |
| mustBeAccepted | `boolean` | The mandatory `mustBeAccepted` property is used to differentiate between required and optional RequestItems within the Request.<br>{::nomarkdown}<ul><li>If <code>mustBeAccepted</code> is set to <code>true</code>, the peer cannot <a href="{% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}">accept the Request</a> without accepting this RequestItem.</li><li>If <code>mustBeAccepted</code> is set to <code>false</code>, the peer can <a href="{% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}">accept the Request</a> even though the RequestItem is rejected.</ul>{:/} |

#### TransferFileOwnershipRequestItem

For more information you should check out the section [TransferFileOwnershipRequestItem of the Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}#transferfileownershiprequestitem).
Expand Down Expand Up @@ -1284,6 +1310,15 @@ The parameters to accept a ReadAttributeRequestItem with a new Attribute.
| accept | `"true"` | The only possible value here is the string "true". |
| newAttribute | `IdentityAttribute` \| `RelationshipAttribute` | The new Attribute. |

#### AcceptShareAuthorizationRequestRequestItemParameters

The parameters to accept a ShareAuthorizationRequestRequestItem.

| Name | Type | Description |
| ----------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| accept | `"true"` | The only possible value here is the string "true". |
| attributeId | `string` | The `id` of the LocalAttribute with content IdentityAttribute and value type [VerifiableCredential]({% link _docs_integrate/attribute-values.md %}#verifiablecredential). |

## IdentityMetadata

An Integrator of a Connector should be able to store arbitrary auxiliary metadata related to an [Identity](#identity) within the Connector and to [manage such IdentityMetadata]({% link _docs_integrate/manage-identitymetadata.md %}).
Expand Down
32 changes: 32 additions & 0 deletions _docs_integrate/request-and-response-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,38 @@ After the Recipient has responded to the ShareAttributeRequestItem, a suitable [
- After rejecting this RequestItem, a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred.
- In case of an error, an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred.

#### ShareAuthorizationRequestRequestItem

If you want to authorize a [VerifiableCredential]({% link _docs_integrate/attribute-values.md %}#verifiablecredential) or certain claims of it via a Request, this is done with the [ShareAuthorizationRequestRequestItem]({% link _docs_integrate/data-model-overview.md %}#shareauthorizationrequestrequestitem).
All details on how to use the ShareAttributeRequestItem and examples of use cases for it can be found in the [Share Attributes with peer]({% link _docs_integrate/share-attributes-with-peer.md %}) guide.

Depending on whether the ShareAuthorizationRequestRequestItem is to be accepted or rejected, its Recipient has different parameters to choose from for responding to it:

- To accept this RequestItem, the [AcceptShareAuthorizationRequestRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#acceptshareauthorizationrequestrequestitemparameters) can be utilized.
- To reject this RequestItem, the [RejectRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#rejectrequestitemparameters) can be utilized.

After the Recipient has responded to the ShareAuthorizationRequestRequestItem, a suitable [ResponseItem]({% link _docs_integrate/data-model-overview.md %}#responseitems) is generated and transferred to the Sender of the Request:

- After accepting this RequestItem, an [AcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#acceptresponseitem) will be transferred.
- After rejecting this RequestItem, a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred.
- In case of an error, an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred.

#### ShareCredentialOfferRequestItem

If you want to issue a [VerifiableCredential]({% link _docs_integrate/attribute-values.md %}#verifiablecredential) via a Request, this is done with the [ShareCredentialOfferRequestItem]({% link _docs_integrate/data-model-overview.md %}#sharecredentialofferrequestitem).
All details on how to use the ShareAttributeRequestItem and examples of use cases for it can be found in the [Share Attributes with peer]({% link _docs_integrate/share-attributes-with-peer.md %}) guide.

Depending on whether the ShareCredentialOfferRequestItem is to be accepted or rejected, its Recipient has different parameters to choose from for responding to it:

- To accept this RequestItem, the [AcceptRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#acceptrequestitemparameters) can be utilized.
- To reject this RequestItem, the [RejectRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#rejectrequestitemparameters) can be utilized.

After the Recipient has responded to the ShareCredentialOfferRequestItem, a suitable [ResponseItem]({% link _docs_integrate/data-model-overview.md %}#responseitems) is generated and transferred to the Sender of the Request:

- After accepting this RequestItem, an [AcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#acceptresponseitem) will be transferred.
- After rejecting this RequestItem, a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred.
- In case of an error, an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred.

#### TransferFileOwnershipRequestItem

If you want to transfer the ownership of a [File]({% link _docs_integrate/data-model-overview.md %}#file), this is done with the [TransferFileOwnershipRequestItem]({% link _docs_integrate/data-model-overview.md %}#transferfileownershiprequestitem).
Expand Down
Loading