Credential configuration reference
Fields of a credential configuration, as accepted by POST /api/issuer/credentials, PATCH /api/issuer/credentials/{id} (any subset of the fields; null clears an optional one) and configuration import. The tables are generated from the Zod schema the backend validates with; unknown fields are rejected with 400. The fields that a GET response adds (tenantId and the resolved references) are ignored, so a configuration read with GET can be sent back. For how to use the fields, see Configure a credential.
Configuration
| Field | Required | Type / allowed values | Description |
|---|---|---|---|
id | yes | string | Credential configuration identifier. |
description | no | string or null | Optional description for operators and tooling. |
config | yes | object | Issuer metadata-facing credential configuration. |
config.format | yes | string: mso_mdoc | dc+sd-jwt | Credential format emitted by this configuration. |
config.display | yes | array of object | Display metadata shown by wallets, one entry per locale. |
config.display[].locale | yes | string | Language tag of this entry, for example en-US. Each locale may appear once. |
config.display[].name | yes | string | Credential name shown by wallets. |
config.display[].description | no | string | Optional description of the credential for this locale. |
config.display[].background_color | no | string | Optional background color for card-style rendering, as a CSS Color Level 3 numerical value: #rgb, #rrggbb, transparent, or lowercase rgb(), rgba(), hsl() or hsla() with comma-separated values. Without it, wallets use their own. |
config.display[].text_color | no | string | Optional text color for card-style rendering, as a CSS Color Level 3 numerical value: #rgb, #rrggbb, transparent, or lowercase rgb(), rgba(), hsl() or hsla() with comma-separated values. Without it, wallets use their own. |
config.display[].background_image | no | object | Optional background image. |
config.display[].background_image.uri | yes | string | Image URI. |
config.display[].logo | no | object | Optional logo image. |
config.display[].logo.uri | yes | string | Image URI. |
config.scope | no | string | Optional OAuth scope associated with this credential type. |
config.docType | no | string | Optional mDoc document type. |
config.keyAttestationsRequired | no | object | Optional key attestation requirements. |
config.keyAttestationsRequired.key_storage | no | array of string | Required key storage attestations. |
config.keyAttestationsRequired.user_authentication | no | array of string | Required user authentication attestations. |
config.proofTypesSupported | no | array of string: jwt | attestation | Supported proof types for issuance requests. |
config.credentialReusePolicy | no | object | Optional PID/EAA reuse policy published in credential metadata. |
config.credentialReusePolicy.id | yes | string | |
config.credentialReusePolicy.options | no | array of object | |
config.credentialReusePolicy.options[].details | yes | array of string: once_only | limited_time | limited-time | rotating-batch | per-relying-party | |
config.credentialReusePolicy.options[].batch_size | no | integer (minimum 2) | |
config.credentialReusePolicy.options[].reissue_trigger_unused | no | integer (minimum 0) | |
config.credentialReusePolicy.options[].reissue_trigger_lifetime_left | no | integer (minimum 0) | |
fields | yes | array of object | Claim field definitions for credential issuance. |
attributeProviderId | no | string or null | Optional attribute provider id used to resolve claim values. |
webhookEndpointId | no | string or null | Receives the wallet unit revocation webhook (revokeWithWalletUnit). Not used for notifications: they go to the webhook endpoint of the offer. |
vct | no | one of 2 shapes or null | Optional VCT value or structured VCT metadata. |
vct.vct | no | string | Only in shape 1 of 2. VCT identifier. |
vct.name | no | string | Only in shape 1 of 2. Human-readable VCT name. |
vct.description | no | string | Only in shape 1 of 2. Optional VCT description. |
vct.extends | no | string | Only in shape 1 of 2. Optional base VCT reference. |
vct.extends#integrity | no | string | Only in shape 1 of 2. Integrity hash for the extends reference. |
vct.schema_uri | no | string | Only in shape 1 of 2. Optional schema URI for the VCT. |
vct.schema_uri#integrity | no | string | Only in shape 1 of 2. Integrity hash for schema_uri. |
keyBinding | no | boolean | Enable key binding requirements. |
keyChainId | no | string | Optional key chain id used for credential signing. |
statusManagement | no | boolean | Enable status management for issued credentials. |
activeCredentials | no | object or null | Optional issuer-side policy limiting simultaneously active credentials per subject. Requires statusManagement. |
activeCredentials.enabled | yes | boolean | Ensure a subject has at most one active credential of this configuration. |
activeCredentials.tracking | no | string: internal | How the subject's active credential set is tracked. Only 'internal' (pseudonymous, issuer-side) is currently supported. |
revokeWithWalletUnit | no | boolean | Revoke issued credentials when the wallet unit attestation (the key attestation of the proof) they were bound to is revoked. Requires statusManagement and config.keyAttestationsRequired. |
iaeActions | no | array of one of 2 shapes or null | Interactive authorization steps (a presentation or a web flow) that the wallet completes, in order, before the credential is issued. |
iaeActions[].label | no | string | Optional UI label for the action. |
iaeActions[].type | yes | string: redirect_to_web | Only when type is redirect_to_web. Trigger a redirect-to-web action. |
iaeActions[].url | yes | string | Only when type is redirect_to_web. Destination URL for the redirect action. |
iaeActions[].callbackUrl | no | string | Only when type is redirect_to_web. Optional callback URL after redirect completion. |
iaeActions[].description | no | string | Only when type is redirect_to_web. Optional action description. |
iaeActions[].type | yes | string: openid4vp_presentation | Only when type is openid4vp_presentation. Trigger an OpenID4VP presentation action. |
iaeActions[].presentationConfigId | yes | string | Only when type is openid4vp_presentation. Presentation configuration id to execute. |
sdJwtTrustFormat | no | string or null: x5c | federation | Trust format used for SD-JWT verification metadata. |
lifeTime | no | integer (minimum 1) | Credential lifetime in seconds. |
schemaMeta | no | object or null | Optional schema metadata and trust bindings. |
schemaMeta.id | no | string | Optional schema metadata identifier. |
schemaMeta.name | no | string | Optional schema metadata name. |
schemaMeta.version | yes | string | Schema metadata version. |
schemaMeta.rulebookURI | no | string | Optional rulebook URI reference. |
schemaMeta.attestationLoS | yes | string: iso_18045_high | iso_18045_moderate | iso_18045_enhanced-basic | iso_18045_basic | Assurance level for attestation requirements. |
schemaMeta.bindingType | yes | string: claim | key | biometric | none | Subject binding type. |
schemaMeta.schemaURIs | no | array of object | Optional schema URI entries. |
schemaMeta.schemaURIs[].credentialConfigId | no | string | Optional credential configuration id this schema URI applies to. |
schemaMeta.schemaURIs[].format | no | string | Optional credential format for this schema URI. |
schemaMeta.schemaURIs[].uri | no | string | Schema URI reference. |
schemaMeta.schemaURIs[].meta | no | object | Optional metadata attached to the schema URI. |
schemaMeta.trustedAuthorities | no | array of object | Optional trusted authority entries. |
schemaMeta.trustedAuthorities[].trustListId | no | string | Optional trust list id. |
schemaMeta.trustedAuthorities[].frameworkType | no | string: aki | etsi_tl | openid_federation | x509 | Trust framework type. x509 takes a root certificate in value and no verificationMethod. |
schemaMeta.trustedAuthorities[].value | no | string | Framework-specific authority value, for example the trust list URL for etsi_tl or the root certificate (base64 DER or PEM) for x509. |
schemaMeta.trustedAuthorities[].verificationMethod | no | one of 2 shapes | Verification method descriptor. |
embeddedDisclosurePolicy | no | one of 4 shapes or null | Optional embedded disclosure policy. |
embeddedDisclosurePolicy.policy | yes | string: attestationBased | Only when policy is attestationBased. Attestation-based policy discriminator. |
embeddedDisclosurePolicy.values | yes | array of object | Only when policy is attestationBased. Attestation requirements used for policy enforcement. |
embeddedDisclosurePolicy.values[].claims | no | array of any | Only when policy is attestationBased. Claims constraints considered by policy evaluation. |
embeddedDisclosurePolicy.values[].credentials | yes | array of any | Only when policy is attestationBased. Credential constraints considered by policy evaluation. |
embeddedDisclosurePolicy.values[].credential_sets | no | array of any | Only when policy is attestationBased. Optional credential set constraints. |
embeddedDisclosurePolicy.policy | yes | string: allowList | Only when policy is allowList. Allow-list based policy discriminator. |
embeddedDisclosurePolicy.values | yes | array of string | Only when policy is allowList. Allowed values for policy checks. |
embeddedDisclosurePolicy.policy | yes | string: rootOfTrust | Only when policy is rootOfTrust. Root-of-trust policy discriminator. |
embeddedDisclosurePolicy.values | yes | string | Only when policy is rootOfTrust. Root-of-trust identifier or reference. |
embeddedDisclosurePolicy.policy | yes | string: none | Only when policy is none. No disclosure policy enforcement. |
Notes on fields whose generated description is incomplete:
| Field | Note |
|---|---|
config.display[].locale | A BCP 47 language tag. The Web Client offers the 24 official EU languages as language-only tags such as en and de, which wallets match for every regional setting of that language; a stored tag such as de-DE is kept when you edit the configuration. Compared case-insensitively: en-US and en-us count as the same locale. A new entry in the Web Client starts in a language no entry has yet, and a language an entry already has, even as en-US, is not offered for another entry; stored regional pairs such as en-US and en-GB stay valid. |
config.scope | Published as scope in the issuer metadata only. EUDIPLO does not map OAuth scopes to credential configurations; wallets select credentials with authorization_details. |
config.proofTypesSupported | Defaults to both jwt and attestation. |
config.credentialReusePolicy.options[] | batch_size (minimum 2) is required for once_only, rotating-batch and per-relying-party. reissue_trigger_unused is required for once_only and must be lower than batch_size. reissue_trigger_lifetime_left (seconds) is required for limited_time, rotating-batch and per-relying-party. options is required when id is arf_annex_ii. See Reuse policy. |
webhookEndpointId | Receives the wallet unit revocation webhook. Notifications use the webhookEndpointId of the credential offer. |
iaeActions | Actions of the Interactive Authorization Endpoint. |
activeCredentials | Rejected unless statusManagement is true. See Single active credential. |
revokeWithWalletUnit | Rejected unless statusManagement is true and config.keyAttestationsRequired is set. Exports include it only when it is true. See Revoke credentials with their wallet unit. |
sdJwtTrustFormat | x5c (default) or federation. See OpenID Federation. |
schemaMeta | TS11 schema metadata of the credential type (version, rulebook, level of security, binding, schema URIs, trusted authorities). Stored and exported with the configuration; EUDIPLO currently publishes it nowhere. |
Claim field (fields[])
Each entry of fields describes one claim. children holds nested entries with the same shape.
| Field | Required | Type / allowed values | Description |
|---|---|---|---|
path | yes | array of string | number or null | Path to this claim inside the credential payload. |
type | yes | string: string | number | integer | boolean | object | array | Data type of the claim value. |
defaultValue | no | any | Optional default value for this field. |
mandatory | no | boolean | Whether the field is required at issuance time. |
disclosable | no | boolean | Whether the claim is selectively disclosable. |
namespace | no | string | Optional namespace for claim grouping. |
display | no | array of object | Localized display metadata for this field. |
display[].locale | yes | string | Locale tag for the display entry. |
display[].name | yes | string | Human-readable field name. |
display[].description | no | string | Optional field description for this locale. |
constraints | no | object | Optional JSON Schema 2020-12 validation keywords for the claim value. Only the JSON Schema keywords listed under Constraints in the claims documentation are accepted (validation keywords such as pattern, minLength or enum, subschemas such as items or properties, and annotations); other keys, such as format or $ref, are refused. |
children | no | array of any | Nested child claim definitions for object or array fields. |
Defaults that are not part of the schema: mandatory and disclosable are false when omitted. namespace (mDOC only) defaults to the first path segment of a nested path, otherwise to the document type (org.iso.18013.5.1 for org.iso.18013.5.1.mDL). In path, null stands for every element of an array.
Example
{
"id": "membership",
"description": "Membership card",
"config": {
"format": "dc+sd-jwt",
"display": [
{
"name": "Membership",
"locale": "en",
"background_color": "#12107c",
"text_color": "#FFFFFF",
"logo": { "uri": "https://issuer.example.com/logo.png" }
}
]
},
"vct": "urn:example:membership:1",
"keyBinding": true,
"statusManagement": true,
"lifeTime": 31536000,
"fields": [
{
"path": ["name"],
"type": "string",
"mandatory": true,
"disclosable": true,
"display": [{ "locale": "en", "name": "Name" }]
},
{
"path": ["member_id"],
"type": "string",
"mandatory": true,
"disclosable": true,
"display": [{ "locale": "en", "name": "Member ID" }]
}
]
}