Skip to content

Commit 1cc9682

Browse files
committed
fix: include mdoc in documentation
Signed-off-by: Mirko Mollik <mirko.mollik@eudi.sprind.org>
1 parent 160d6cb commit 1cc9682

File tree

4 files changed

+80
-4
lines changed

4 files changed

+80
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ management, scalable database support, and clean API boundaries.
3737

3838
## 🧩 Features
3939

40-
- ✅ Supports **OID4VCI**, **OID4VP**, **SD-JWT VC**, and **OAuth Token Status
40+
- ✅ Supports **OID4VCI**, **OID4VP**, **SD-JWT VC**, **mDOC (ISO 18013-5)**, and **OAuth Token Status
4141
List**
4242
-**OIDF conformance tested** for OID4VCI and OID4VP protocols
4343
- ✅ JSON-based credential configuration

docs/architecture/supported-protocols.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ technical framework.
1616
| [OpenID for Verifiable Credential Issuance (OID4VCI)](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html) | Enables issuers to deliver verifiable credentials to EUDI Wallets using OAuth-based flows. |
1717
| [OpenID for Verifiable Presentations (OID4VP)](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) | Allows services to request and verify credentials presented by EUDI Wallet holders. |
1818
| [Selective Disclosure JWT VC (SD-JWT VC)](https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-08.html) | Data model for credentials allowing selective disclosure of individual claims by the user. |
19+
| [Mobile Driving License (mDOC/mDL)](https://www.iso.org/standard/69084.html) | ISO 18013-5 standard for mobile driving licenses and other mobile documents. |
1920
| [OAuth Token Status List](https://drafts.oauth.net/draft-ietf-oauth-status-list/draft-ietf-oauth-status-list.html) | Mechanism for determining revocation or suspension status of issued credentials. |
2021

2122
These standards are evolving in coordination with EU-level pilot projects and

docs/getting-started/issuance/credential-configuration.md

Lines changed: 77 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,13 @@ For a complete configuration example, see the [Complete Configuration Example](#
2424
- `id`: **REQUIRED** - Unique identifier for the credential configuration that will be used to reference this credential in the issuance metadata or in the credential offer.
2525
- `config`: **REQUIRED** - Entry for
2626
[credential_configuration_supported](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-issuer-metadata:~:text=the%20logo%20image.-,credential_configurations_supported,-%3A%20REQUIRED.%20Object%20that).
27-
- `format`: **REQUIRED** - The format of the credential, only `dc+sd-jwt` is
28-
currently supported.
27+
- `format`: **REQUIRED** - The format of the credential. Supported formats:
28+
- `dc+sd-jwt` - Selective Disclosure JWT Verifiable Credentials
29+
- `mso_mdoc` - Mobile Document (ISO 18013-5)
2930
- `display`: **REQUIRED** - Display configuration for the credential,
3031
including name, description, locale, colors, and images.
32+
- `docType`: **REQUIRED for mso_mdoc** - Document type identifier (e.g., `org.iso.18013.5.1.mDL`).
33+
- `namespace`: **OPTIONAL for mso_mdoc** - Default namespace for claims (e.g., `org.iso.18013.5.1`). If not provided, derived from docType.
3134

3235
### Optional Fields
3336

@@ -200,6 +203,78 @@ This configuration allows:
200203

201204
---
202205

206+
## mDOC Credential Format
207+
208+
For issuing mobile documents following the ISO 18013-5 standard (such as Mobile Driving Licenses), use the `mso_mdoc` format.
209+
210+
### Basic mDOC Configuration
211+
212+
```json
213+
{
214+
"id": "pid-mdoc",
215+
"description": "Personal ID as mDL",
216+
"config": {
217+
"format": "mso_mdoc",
218+
"docType": "org.iso.18013.5.1.mDL",
219+
"namespace": "org.iso.18013.5.1",
220+
"scope": "mdl",
221+
"display": [
222+
{
223+
"name": "Mobile Driving License",
224+
"description": "mDL Credential",
225+
"locale": "en-US"
226+
}
227+
]
228+
},
229+
"claims": {
230+
"given_name": "ERIKA",
231+
"family_name": "MUSTERMANN",
232+
"birth_date": "1964-08-12",
233+
"issuing_country": "DE"
234+
},
235+
"keyBinding": true
236+
}
237+
```
238+
239+
### mDOC-Specific Fields
240+
241+
| Field | Required | Description |
242+
| ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
243+
| `docType` | Yes | Document type identifier following ISO 18013-5 naming convention (e.g., `org.iso.18013.5.1.mDL`) |
244+
| `namespace` | No | Default namespace for claims. If not provided, derived from `docType`. For mDL, this is typically `org.iso.18013.5.1` |
245+
| `claimsByNamespace` | No | Alternative to `claims` - allows specifying claims across multiple namespaces |
246+
247+
### Multiple Namespaces
248+
249+
For credentials that require claims from multiple namespaces, use `claimsByNamespace`:
250+
251+
```json
252+
{
253+
"config": {
254+
"format": "mso_mdoc",
255+
"docType": "org.iso.18013.5.1.mDL",
256+
"display": [{ "name": "mDL", "locale": "en-US" }]
257+
},
258+
"claimsByNamespace": {
259+
"org.iso.18013.5.1": {
260+
"given_name": "ERIKA",
261+
"family_name": "MUSTERMANN"
262+
},
263+
"org.iso.18013.5.1.aamva": {
264+
"DHS_compliance": "F"
265+
}
266+
}
267+
}
268+
```
269+
270+
!!! note "Key Binding Required"
271+
For mDOC credentials, `keyBinding` should typically be set to `true` as the ISO 18013-5 standard requires device authentication.
272+
273+
!!! info "Selective Disclosure"
274+
Unlike SD-JWT, mDOC credentials have built-in selective disclosure at the namespace and claim level. The `disclosureFrame` field is not used for mDOC format.
275+
276+
---
277+
203278
## Display Configuration
204279

205280
The display configuration defines how the credential appears in wallets as defined in the [OID4VCI spec](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-issuer-metadata-p) for the credential metadata:

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ yourself.
2424

2525
Connecting to the EUDI Wallet ecosystem is technically demanding:
2626

27-
- You must understand **OID4VCI**, **OID4VP**, **SD-JWT VC**, and **OAuth-based
27+
- You must understand **OID4VCI**, **OID4VP**, **SD-JWT VC**, **mDOC (ISO 18013-5)**, and **OAuth-based
2828
status protocols**.
2929
- Libraries are scattered, often **incomplete or language-specific**.
3030
- Hosted services can lead to **vendor lock-in** or obscure how your data is

0 commit comments

Comments
 (0)