Skip to main content

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​

FieldRequiredType / allowed valuesDescription
idyesstringCredential configuration identifier.
descriptionnostring or nullOptional description for operators and tooling.
configyesobjectIssuer metadata-facing credential configuration.
config.formatyesstring: mso_mdoc | dc+sd-jwtCredential format emitted by this configuration.
config.displayyesarray of objectDisplay metadata shown by wallets, one entry per locale.
config.display[].localeyesstringLanguage tag of this entry, for example en-US. Each locale may appear once.
config.display[].nameyesstringCredential name shown by wallets.
config.display[].descriptionnostringOptional description of the credential for this locale.
config.display[].background_colornostringOptional 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_colornostringOptional 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_imagenoobjectOptional background image.
config.display[].background_image.uriyesstringImage URI.
config.display[].logonoobjectOptional logo image.
config.display[].logo.uriyesstringImage URI.
config.scopenostringOptional OAuth scope associated with this credential type.
config.docTypenostringOptional mDoc document type.
config.keyAttestationsRequirednoobjectOptional key attestation requirements.
config.keyAttestationsRequired.key_storagenoarray of stringRequired key storage attestations.
config.keyAttestationsRequired.user_authenticationnoarray of stringRequired user authentication attestations.
config.proofTypesSupportednoarray of string: jwt | attestationSupported proof types for issuance requests.
config.credentialReusePolicynoobjectOptional PID/EAA reuse policy published in credential metadata.
config.credentialReusePolicy.idyesstring
config.credentialReusePolicy.optionsnoarray of object
config.credentialReusePolicy.options[].detailsyesarray of string: once_only | limited_time | limited-time | rotating-batch | per-relying-party
config.credentialReusePolicy.options[].batch_sizenointeger (minimum 2)
config.credentialReusePolicy.options[].reissue_trigger_unusednointeger (minimum 0)
config.credentialReusePolicy.options[].reissue_trigger_lifetime_leftnointeger (minimum 0)
fieldsyesarray of objectClaim field definitions for credential issuance.
attributeProviderIdnostring or nullOptional attribute provider id used to resolve claim values.
webhookEndpointIdnostring or nullReceives the wallet unit revocation webhook (revokeWithWalletUnit). Not used for notifications: they go to the webhook endpoint of the offer.
vctnoone of 2 shapes or nullOptional VCT value or structured VCT metadata.
vct.vctnostringOnly in shape 1 of 2. VCT identifier.
vct.namenostringOnly in shape 1 of 2. Human-readable VCT name.
vct.descriptionnostringOnly in shape 1 of 2. Optional VCT description.
vct.extendsnostringOnly in shape 1 of 2. Optional base VCT reference.
vct.extends#integritynostringOnly in shape 1 of 2. Integrity hash for the extends reference.
vct.schema_urinostringOnly in shape 1 of 2. Optional schema URI for the VCT.
vct.schema_uri#integritynostringOnly in shape 1 of 2. Integrity hash for schema_uri.
keyBindingnobooleanEnable key binding requirements.
keyChainIdnostringOptional key chain id used for credential signing.
statusManagementnobooleanEnable status management for issued credentials.
activeCredentialsnoobject or nullOptional issuer-side policy limiting simultaneously active credentials per subject. Requires statusManagement.
activeCredentials.enabledyesbooleanEnsure a subject has at most one active credential of this configuration.
activeCredentials.trackingnostring: internalHow the subject's active credential set is tracked. Only 'internal' (pseudonymous, issuer-side) is currently supported.
revokeWithWalletUnitnobooleanRevoke issued credentials when the wallet unit attestation (the key attestation of the proof) they were bound to is revoked. Requires statusManagement and config.keyAttestationsRequired.
iaeActionsnoarray of one of 2 shapes or nullInteractive authorization steps (a presentation or a web flow) that the wallet completes, in order, before the credential is issued.
iaeActions[].labelnostringOptional UI label for the action.
iaeActions[].typeyesstring: redirect_to_webOnly when type is redirect_to_web. Trigger a redirect-to-web action.
iaeActions[].urlyesstringOnly when type is redirect_to_web. Destination URL for the redirect action.
iaeActions[].callbackUrlnostringOnly when type is redirect_to_web. Optional callback URL after redirect completion.
iaeActions[].descriptionnostringOnly when type is redirect_to_web. Optional action description.
iaeActions[].typeyesstring: openid4vp_presentationOnly when type is openid4vp_presentation. Trigger an OpenID4VP presentation action.
iaeActions[].presentationConfigIdyesstringOnly when type is openid4vp_presentation. Presentation configuration id to execute.
sdJwtTrustFormatnostring or null: x5c | federationTrust format used for SD-JWT verification metadata.
lifeTimenointeger (minimum 1)Credential lifetime in seconds.
schemaMetanoobject or nullOptional schema metadata and trust bindings.
schemaMeta.idnostringOptional schema metadata identifier.
schemaMeta.namenostringOptional schema metadata name.
schemaMeta.versionyesstringSchema metadata version.
schemaMeta.rulebookURInostringOptional rulebook URI reference.
schemaMeta.attestationLoSyesstring: iso_18045_high | iso_18045_moderate | iso_18045_enhanced-basic | iso_18045_basicAssurance level for attestation requirements.
schemaMeta.bindingTypeyesstring: claim | key | biometric | noneSubject binding type.
schemaMeta.schemaURIsnoarray of objectOptional schema URI entries.
schemaMeta.schemaURIs[].credentialConfigIdnostringOptional credential configuration id this schema URI applies to.
schemaMeta.schemaURIs[].formatnostringOptional credential format for this schema URI.
schemaMeta.schemaURIs[].urinostringSchema URI reference.
schemaMeta.schemaURIs[].metanoobjectOptional metadata attached to the schema URI.
schemaMeta.trustedAuthoritiesnoarray of objectOptional trusted authority entries.
schemaMeta.trustedAuthorities[].trustListIdnostringOptional trust list id.
schemaMeta.trustedAuthorities[].frameworkTypenostring: aki | etsi_tl | openid_federation | x509Trust framework type. x509 takes a root certificate in value and no verificationMethod.
schemaMeta.trustedAuthorities[].valuenostringFramework-specific authority value, for example the trust list URL for etsi_tl or the root certificate (base64 DER or PEM) for x509.
schemaMeta.trustedAuthorities[].verificationMethodnoone of 2 shapesVerification method descriptor.
embeddedDisclosurePolicynoone of 4 shapes or nullOptional embedded disclosure policy.
embeddedDisclosurePolicy.policyyesstring: attestationBasedOnly when policy is attestationBased. Attestation-based policy discriminator.
embeddedDisclosurePolicy.valuesyesarray of objectOnly when policy is attestationBased. Attestation requirements used for policy enforcement.
embeddedDisclosurePolicy.values[].claimsnoarray of anyOnly when policy is attestationBased. Claims constraints considered by policy evaluation.
embeddedDisclosurePolicy.values[].credentialsyesarray of anyOnly when policy is attestationBased. Credential constraints considered by policy evaluation.
embeddedDisclosurePolicy.values[].credential_setsnoarray of anyOnly when policy is attestationBased. Optional credential set constraints.
embeddedDisclosurePolicy.policyyesstring: allowListOnly when policy is allowList. Allow-list based policy discriminator.
embeddedDisclosurePolicy.valuesyesarray of stringOnly when policy is allowList. Allowed values for policy checks.
embeddedDisclosurePolicy.policyyesstring: rootOfTrustOnly when policy is rootOfTrust. Root-of-trust policy discriminator.
embeddedDisclosurePolicy.valuesyesstringOnly when policy is rootOfTrust. Root-of-trust identifier or reference.
embeddedDisclosurePolicy.policyyesstring: noneOnly when policy is none. No disclosure policy enforcement.

Notes on fields whose generated description is incomplete:

FieldNote
config.display[].localeA 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.scopePublished as scope in the issuer metadata only. EUDIPLO does not map OAuth scopes to credential configurations; wallets select credentials with authorization_details.
config.proofTypesSupportedDefaults 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.
webhookEndpointIdReceives the wallet unit revocation webhook. Notifications use the webhookEndpointId of the credential offer.
iaeActionsActions of the Interactive Authorization Endpoint.
activeCredentialsRejected unless statusManagement is true. See Single active credential.
revokeWithWalletUnitRejected unless statusManagement is true and config.keyAttestationsRequired is set. Exports include it only when it is true. See Revoke credentials with their wallet unit.
sdJwtTrustFormatx5c (default) or federation. See OpenID Federation.
schemaMetaTS11 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.

FieldRequiredType / allowed valuesDescription
pathyesarray of string | number or nullPath to this claim inside the credential payload.
typeyesstring: string | number | integer | boolean | object | arrayData type of the claim value.
defaultValuenoanyOptional default value for this field.
mandatorynobooleanWhether the field is required at issuance time.
disclosablenobooleanWhether the claim is selectively disclosable.
namespacenostringOptional namespace for claim grouping.
displaynoarray of objectLocalized display metadata for this field.
display[].localeyesstringLocale tag for the display entry.
display[].nameyesstringHuman-readable field name.
display[].descriptionnostringOptional field description for this locale.
constraintsnoobjectOptional 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.
childrennoarray of anyNested 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" }]
}
]
}