Configuration
Set CONFIG_PATH to an absolute configuration file path. Without it, the file
loader searches for config.yaml or another supported config file format in
the process's current directory and its parents. The application validates the
loaded configuration at startup.
Environment variables override file settings. Use the uppercase TSG__ prefix,
double underscores between path segments and snake case for camel-case keys.
For example, TSG__SERVER__PUBLIC_ADDRESS overrides server.publicAddress.
Databases
By default, the development database is sqlite. We use postgres databases for production type instances of the wallets.
Authentication
Browser access uses an explicitly registered SSO client and the configured receiving audience. Use the SSO Bridge with Tenant Management for managed organization access; an OAuth login alone does not establish the required organization, grant and lifecycle state. See the managed deployment guide.
DID Method
Two DID methods are currently supported: did:web and did:tdw. A comparison between the two is given below. The decision of which configuration to select should be made based on the specific use case of the wallet.
| did:web | did:tdw | did:key | |
|---|---|---|---|
| TSG Configuration value: | did:web: | did:tdw: | - (DID Key is only supported for DID resolution but not for creation) |
| Specification link: | W3C internal document | BCGov specification draft | W3C internal document |
| Supported version: | Unofficial draft | Draft v1 | Unofficial draft v0.7 |
| Underlying technology: | Web-based DID method that serves the DID Document as a JSON under a certain endpoint (.well-known path) of a web domain that is accessible by the public. | Web-based DID method that utilizes a public JSON Lines file hosted under a web domain to store each change (create, update, delete) that occurs on a DID Document. The DID Document is then resolved by fetching and processing the JSON Lines file. | Multibase Multicodec public key, with generated DID document |
| Identifier format: | did:web:{{public web domain}}e.g. did:web:example.com | did:tdw:{{public web domain}}:{{generated self-certifying identifier}}e.g. did:tdw:example.com:b7ep277b2mvxdpcrbja3iergubfy | did:key:{{ Public key }} |
| Advantages: | Straightforward implementation with no additional processing other than hosting DID Document on web server. | Additional security and validation mechanisms contained in the JSON Lines file that increases trustworthiness of DID Document. | No server implementation required, so very suitable for mobile wallets |
| Disadvantages: | Easily compromisable without notice by resolving parties when malicious access is gained to the web server. | DID Document is not directly available as extra processing to verify signatures and validate entry hashes retrieved from the JSON Lines file needs to be performed to resolve the DID Document. | DID document only contains the verification method, so additional properties like service are not supported |
Managed organizations
A Wallet process serves managed participants. Each has its own keys, DID, credentials and issuer configuration. Tenant Management creates or explicitly imports the organization and keeps its authorization snapshots fresh. The process starts with no tenants. Organization creation, membership changes and invitations are managed through Tenant Management.
Global key and issue-configuration settings define the provisioning defaults for new managed Wallet tenants. They do not claim existing keys, bind old rows to a new organization or create a tenant at startup. See the deployment and import guide.
Addressing
Public DID and credential endpoints use
https://wallet.example/tenants/<local-slug>/..., with DID
did:web:wallet.example:tenants:<local-slug>. Management requests select the
local tenant through X-Tenant-Slug or X-Tenant-Id; OAuth tenant_id carries
the canonical organization UUID. The selector grants no access.
Existing Wallet data
Old seeded configuration no longer starts. Back up its databases, keys and secrets, then explicitly import the existing local tenant ID, URL slug, DID and resource ownership through Tenant Management. Retain the published URLs and keys. Creating a replacement tenant or matching a slug does not migrate the existing identity. Follow the import procedure before reopening managed access.
Issue Configurations
Issue configurations define the structure, validation rules, and visual presentation of credential types that the wallet can issue and manage. Each configuration combines semantic interoperability through JSON-LD contexts with schema validation and visual styling.
JSON-LD Context and Schema Relationship
Issue configurations leverage both JSON-LD contexts and JSON Schema for comprehensive credential definition:
- JSON-LD Context (
documentordocumentUrl): Defines semantic meaning of credential properties for interoperability across systems - JSON Schema (
schema): Defines structure, validation rules, and user interface information for credential properties
Schema-Driven User Interface
The JSON Schema directly influences how credentials are presented to users:
- Property Order: Schema property order determines display order in user interfaces
- Human-Readable Titles: The
titleproperty provides user-friendly labels instead of technical property names - Example Values: The
exampleproperty shows users expected data format - Validation Rules: Properties like
enum,pattern, andrequiredensure data quality and guide user input when issuing credentials
Visual Styling
Issue configurations support visual customization through:
- Background Color (
backgroundColor): Hex color code for credential background - Background Image (
backgroundImage): URL or base64-encoded image for credential branding. PNG-based images are recommended for transparency support and support across applications. - Text Color (
textColor): Hex color code for credential text - Display Metadata (
name,description): Human-readable credential information
Possible configuration parameters
initSelfIssuedCredentials contains per-tenant credential templates. Each new
Wallet signs them with its own key and sets the issuer and subject ID to its own
DID. Template IDs are tenant-local fragments. These templates do not import a
shared credential or grant admission to a real dataspace.
tenancy.initializations selects operator-owned key configuration for an exact
canonical tenant UUID, such as the separate development X.509 keys in the Gaia-X
sample. Unlisted tenants use generated initKeys. Initialization and its receipt
commit together; reconciliation and restarts preserve later key changes.
| Key | Required | Type | Description | Default |
|---|---|---|---|---|
WalletTenancyConfig | ||||
tenancy | WalletTenancyConfig | undefined | ||
WalletTenantInitialization | ||||
tenancy.initializations | WalletTenantInitialization[] | Operator-owned initialization for exact canonical tenants, including tenant-specific X.509 keys | [] | |
tenancy.initializations[].tenantId | Yes | String | Canonical tenant UUID assigned by Tenant Management | |
InitKeyConfig | ||||
tenancy.initializations[].keys | Yes | InitKeyConfig[] | Keys for this exact canonical tenant, never copied into other tenants | |
tenancy.initializations[].keys[].type | Yes | "EdDSA" | "ES384" | "X509" | Type of key | |
tenancy.initializations[].keys[].id | Yes | String | ID of the key | |
tenancy.initializations[].keys[].default | Boolean | Default key | false | |
tenancy.initializations[].keys[].existingKey | String | Existing PKCS#8 encoded key | ||
tenancy.initializations[].keys[].existingCertificate | String | Existing PEM encoded certificate | ||
tenancy.mode | "managed" | Tenant state is provisioned by Tenant Management | "managed" | |
tenancy.controlPlaneUrls | String | Operator-registered Control Plane API bases used for Wallet connector DID services | [] | |
tenancy.serviceInstanceId | String | Operator-registered receiving service instance | "" | |
tenancy.managementUrl | String | Tenant Management UI URL | ||
tenancy.provisioningIdentities | Object | Exact manager issuer/subject, audience and allowed provisioning operations | [] | |
tenancy.platformPrincipals | Object | Exact human principals permitted to change shared process settings; organization roles grant no platform authority | [] | |
DatabaseConfig | ||||
db | Yes | DatabaseConfig | Database configuration | |
db.retryAttempts | Number | Connection attempts during application startup, three seconds apart | 10 | |
db.type | Yes | "sqlite" | "postgres" | Type of database | |
db.database | Yes | String | Name of the database | |
db.synchronize | Boolean | Synchronize database schema | false | |
db{type=sqlite} | Yes | SQLiteConfig | Database configuration | |
db{type=sqlite}.retryAttempts | Number | Connection attempts during application startup, three seconds apart | 10 | |
db{type=sqlite}.type | "sqlite" | "postgres" | Type of database | "sqlite" | |
db{type=sqlite}.database | Yes | String | Name of the database | |
db{type=sqlite}.synchronize | Boolean | Synchronize database schema | false | |
db{type=postgres} | Yes | PostgresConfig | Database configuration | |
db{type=postgres}.host | Yes | String | Host of the database | |
db{type=postgres}.port | Yes | Number | Port of the database | |
db{type=postgres}.username | Yes | String | Username of the database | |
db{type=postgres}.password | Yes | String | Password of the database | |
db{type=postgres}.ssl | Object | SSL configuration of the database | false | |
db{type=postgres}.retryAttempts | Number | Connection attempts during application startup, three seconds apart | 10 | |
db{type=postgres}.type | "sqlite" | "postgres" | Type of database | "postgres" | |
db{type=postgres}.database | Yes | String | Name of the database | |
db{type=postgres}.synchronize | Boolean | Synchronize database schema | false | |
ServerConfig | ||||
server | ServerConfig | Server configuration | ||
server.listen | String | IP address the server listens on | "0.0.0.0" | |
server.port | Number | Port the server listens on | 3000 | |
server.publicDomain | String | Public domain of the server | "localhost" | |
server.publicAddress | String | Public address of the server | "http://localhost:3000" | |
server.subPath | String | Sub path of the server | ||
AuthConfig | ||||
auth | Yes | AuthConfig | Management authentication configuration | |
auth.signalingId | String | Receiving plane identity for signaling tokens. Defaults to clientId. | ||
auth.expectedIssuer | String | Expected API token issuer; defaults to the discovered OpenID issuer | ||
auth.expectedAudience | String | Expected API token audience; defaults to clientId. | ||
auth.enabled | Boolean | Enable authentication | true | |
auth.openIdConfigurationURL | String | OpenID configuration URL | ||
auth.callbackURL | URL | Callback URL the auth service will redirect users | ||
auth.redirectURL | URL | Redirect URL to UI after login/logout | ||
auth.clientId | String | Client ID | ||
auth.clientSecret | String | Client secret (required for client_secret_post authentication) | ||
auth.tokenEndpointAuthMethod | "client_secret_post" | "private_key_jwt" | Token endpoint authentication method: client_secret_post (default) or private_key_jwt | "client_secret_post" | |
auth.privateKeyJwk | Object | Private key in JWK format for private_key_jwt authentication. Alternative to privateKeyJwkFile. | ||
auth.privateKeyJwkFile | String | Path to file containing private key JWK for private_key_jwt authentication. Alternative to privateKeyJwk. | ||
auth.permissionPath | String | JSON path to extract permissions from the token | "$.permissions[*]" | |
NodemailerConfiguration | ||||
email | NodemailerConfiguration | Email configuration | ||
email.enabled | Boolean | Enable email sending | false | |
email.smtpFrom | String | Email address to send emails from | ||
email.smtpPort | Number | SMTP port | 465 | |
email.smtpSecure | Boolean | SMTP secure connection | true | |
email.smtpServer | String | SMTP server | ||
email.smtpUser | String | SMTP user | ||
email.smtpPassword | String | SMTP password | ||
email.title | String | Title | ||
InitKeyConfig | ||||
initKeys | InitKeyConfig[] | Initial key configurations | [] | |
initKeys[].type | Yes | "EdDSA" | "ES384" | "X509" | Type of key | |
initKeys[].id | Yes | String | ID of the key | |
initKeys[].default | Boolean | Default key | false | |
initKeys[].existingKey | String | Existing PKCS#8 encoded key | ||
initKeys[].existingCertificate | String | Existing PEM encoded certificate | ||
AddScope | ||||
initScopes | AddScope[] | Initial scope configurations | [] | |
initScopes[].alias | Yes | String | Alias of the scope | |
initScopes[].discriminator | Yes | String | Discriminator of the scope, variables must be enclosed in | |
initScopes[].description | Yes | String | Description of the scope | |
PresentationDefinition | ||||
initScopes[].presentationDefinition | Yes | PresentationDefinition | Presentation definition associated with the scope, should include variables from the discriminator | |
initScopes[].presentationDefinition.id | Yes | String | undefined | |
InputDescriptor | ||||
initScopes[].presentationDefinition.input_descriptors | Yes | InputDescriptor[] | undefined | |
initScopes[].presentationDefinition.input_descriptors[].id | Yes | String | undefined | |
initScopes[].presentationDefinition.input_descriptors[].name | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].purpose | String | undefined | ||
Format | ||||
initScopes[].presentationDefinition.input_descriptors[].format | Format | undefined | ||
JwtVpClaimFormat | ||||
initScopes[].presentationDefinition.input_descriptors[].format.jwt_vp | JwtVpClaimFormat | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].format.jwt_vp.alg | Yes | String | undefined | |
Constraint | ||||
initScopes[].presentationDefinition.input_descriptors[].constraints | Yes | Constraint | undefined | |
Field | ||||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields | Field[] | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].path | Yes | String | undefined | |
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].id | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].purpose | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].name | String | undefined | ||
Filter | ||||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter | Filter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.type | Yes | String | undefined | |
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.const | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.enum | Array | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.exclusiveMinimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.exclusiveMaximum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.format | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.minLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.maxLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.minimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.maximum | Object | undefined | ||
NestedFilter | ||||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.type | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.const | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.enum | Array | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.exclusiveMinimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.exclusiveMaximum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.format | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.minLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.maxLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.minimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.maximum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.not | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.pattern | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.contains | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.required | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.properties | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.allOf | NestedFilter[] | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.not.items | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.pattern | String | undefined | ||
NestedFilter | ||||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.type | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.const | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.enum | Array | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.exclusiveMinimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.exclusiveMaximum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.format | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.minLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.maxLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.minimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.maximum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.not | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.pattern | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.contains | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.required | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.properties | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.allOf | NestedFilter[] | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.contains.items | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.required | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.properties | Object | undefined | ||
NestedFilter | ||||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf | NestedFilter[] | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].type | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].const | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].enum | Array | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].exclusiveMinimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].exclusiveMaximum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].format | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].minLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].maxLength | Number | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].minimum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].maximum | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].not | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].pattern | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].contains | NestedFilter | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].required | String | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].properties | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].allOf | NestedFilter[] | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.allOf[].items | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].filter.items | Object | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.fields[].optional | Boolean | undefined | ||
initScopes[].presentationDefinition.input_descriptors[].constraints.limit_disclosure | undefined | |||
initScopes[].presentationDefinition.name | String | undefined | ||
initScopes[].presentationDefinition.purpose | String | undefined | ||
Format | ||||
initScopes[].presentationDefinition.format | Format | undefined | ||
JwtVpClaimFormat | ||||
initScopes[].presentationDefinition.format.jwt_vp | JwtVpClaimFormat | undefined | ||
initScopes[].presentationDefinition.format.jwt_vp.alg | Yes | String | undefined | |
initScopes[].requirementSetId | String | undefined | ||
initScopes[].revision | Number | undefined | ||
initScopes[].digest | String | undefined | ||
initScopes[].immutable | Boolean | undefined | ||
InitCredentialConfig | ||||
initCredentials | InitCredentialConfig[] | Initial credential configurations | [] | |
initCredentials[].context | Array | JSON-LD contexts for the credential | [] | |
initCredentials[].type | String | Types of the verifiable credential | [] | |
initCredentials[].id | Yes | String | ID of the credential | |
initCredentials[].proofType | Type of proof used for the credential | "ldp" | ||
initCredentials[].keyId | String | ID of key signing the credential | ||
initCredentials[].validityDurationMs | Number | Validity duration of self-issued credentials in milliseconds. Defaults to 3 months. | 7776000000 | |
initCredentials[].revocable | Boolean | Revocable credential | true | |
initCredentials[].credentialSubject | Yes | Object | Credential subject; every subject must include a claim besides id. Existing id-only credentials must be re-issued. | |
initCredentials[].evidence | Object | Evidence attached to the verifiable credential | ||
SelfIssuedCredentialTemplate | ||||
initSelfIssuedCredentials | SelfIssuedCredentialTemplate[] | Credential templates signed separately by each new tenant for its own DID. Existing credentials are retained | [] | |
initSelfIssuedCredentials[].id | Yes | String | Tenant-local credential fragment; issuer and subject are the tenant's own DID | |
initSelfIssuedCredentials[].context | Array | JSON-LD contexts for the credential | [] | |
initSelfIssuedCredentials[].type | String | Types of the verifiable credential | [] | |
initSelfIssuedCredentials[].proofType | Type of proof used for the credential | "ldp" | ||
initSelfIssuedCredentials[].keyId | String | ID of key signing the credential | ||
initSelfIssuedCredentials[].validityDurationMs | Number | Validity duration of self-issued credentials in milliseconds. Defaults to 3 months. | 7776000000 | |
initSelfIssuedCredentials[].revocable | Boolean | Revocable credential | true | |
initSelfIssuedCredentials[].credentialSubject | Yes | Object | Credential subject; every subject must include a claim besides id. Existing id-only credentials must be re-issued. | |
initSelfIssuedCredentials[].evidence | Object | Evidence attached to the verifiable credential | ||
TrustAnchorConfig | ||||
trustAnchors | TrustAnchorConfig[] | Trust anchor configurations | [] | |
trustAnchors[].id | Yes | String | DID of the trust anchor | |
trustAnchors[].credentialTypes | String | Credential types trusted of the trust anchor | [] | |
IssueConfigurationConfig | ||||
issueConfigurations | IssueConfigurationConfig[] | Issue configuration settings | [] | |
issueConfigurations[].id | Yes | String | ID of the configuration | |
issueConfigurations[].credentialType | Yes | String | Credential type associated with the configuration | |
issueConfigurations[].proofType | Proof type for the credential | "jwt" | ||
issueConfigurations[].evidence | Object | Evidence attached to credentials issued with this configuration | ||
issueConfigurations[].documentUrl | URL | URL of the JSON-LD context | ||
issueConfigurations[].document | Object | JSON-LD context body | ||
issueConfigurations[].schema | Object | JSON-Schema of the issue configuration | ||
issueConfigurations[].name | String | Display name of the issue configuration | ||
issueConfigurations[].description | String | Description of the issue configuration | ||
issueConfigurations[].backgroundColor | String | Background color for the credential display | ||
issueConfigurations[].backgroundImage | String | Background image for the credential display, must be a URL | ||
issueConfigurations[].textColor | String | Text color for the credential display | ||
PresentationDefinition | ||||
issueConfigurations[].issuancePolicy | PresentationDefinition | Presentation definition that the holder must satisfy before this credential is issued | ||
issueConfigurations[].issuancePolicy.id | Yes | String | undefined | |
InputDescriptor | ||||
issueConfigurations[].issuancePolicy.input_descriptors | Yes | InputDescriptor[] | undefined | |
issueConfigurations[].issuancePolicy.input_descriptors[].id | Yes | String | undefined | |
issueConfigurations[].issuancePolicy.input_descriptors[].name | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].purpose | String | undefined | ||
Format | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].format | Format | undefined | ||
JwtVpClaimFormat | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].format.jwt_vp | JwtVpClaimFormat | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].format.jwt_vp.alg | Yes | String | undefined | |
Constraint | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints | Yes | Constraint | undefined | |
Field | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields | Field[] | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].path | Yes | String | undefined | |
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].id | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].purpose | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].name | String | undefined | ||
Filter | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter | Filter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.type | Yes | String | undefined | |
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.const | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.enum | Array | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.exclusiveMinimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.exclusiveMaximum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.format | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.minLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.maxLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.minimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.maximum | Object | undefined | ||
NestedFilter | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.type | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.const | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.enum | Array | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.exclusiveMinimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.exclusiveMaximum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.format | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.minLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.maxLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.minimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.maximum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.not | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.pattern | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.contains | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.required | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.properties | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.allOf | NestedFilter[] | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.not.items | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.pattern | String | undefined | ||
NestedFilter | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.type | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.const | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.enum | Array | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.exclusiveMinimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.exclusiveMaximum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.format | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.minLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.maxLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.minimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.maximum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.not | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.pattern | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.contains | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.required | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.properties | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.allOf | NestedFilter[] | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.contains.items | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.required | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.properties | Object | undefined | ||
NestedFilter | ||||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf | NestedFilter[] | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].type | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].const | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].enum | Array | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].exclusiveMinimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].exclusiveMaximum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].format | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].minLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].maxLength | Number | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].minimum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].maximum | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].not | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].pattern | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].contains | NestedFilter | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].required | String | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].properties | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].allOf | NestedFilter[] | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.allOf[].items | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].filter.items | Object | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.fields[].optional | Boolean | undefined | ||
issueConfigurations[].issuancePolicy.input_descriptors[].constraints.limit_disclosure | undefined | |||
issueConfigurations[].issuancePolicy.name | String | undefined | ||
issueConfigurations[].issuancePolicy.purpose | String | undefined | ||
Format | ||||
issueConfigurations[].issuancePolicy.format | Format | undefined | ||
JwtVpClaimFormat | ||||
issueConfigurations[].issuancePolicy.format.jwt_vp | JwtVpClaimFormat | undefined | ||
issueConfigurations[].issuancePolicy.format.jwt_vp.alg | Yes | String | undefined | |
issueConfigurations[].canReIssue | Boolean | Whether credentials of this type may be automatically reissued before they expire. Defaults to true. | true | |
IssuanceConfig | ||||
issuance | IssuanceConfig | Issuance configuration | ||
issuance.dcpProfile | "vc20-bssl/jwt" | DCP credential profile used for issuance and requests | "vc20-bssl/jwt" | |
issuance.preAuthorizedCodeTtlMs | Number | Lifetime of OID4VCI pre-authorized codes in milliseconds | 300000 | |
IssuerConfig | ||||
issuance.issuer | IssuerConfig[] | Issuer configuration | [] | |
issuance.issuer[].tenantSlug | String | Tenant slug that acts as issuer (multi-tenant only) | ||
issuance.issuer[].holderId | Yes | String | DID of the holder | |
issuance.issuer[].credentialType | Yes | String | Credential type to be issued | |
issuance.issuer[].credentialId | String | Stable logical credential ID to use for this configured issuance. Defaults to a holder-bound random ID. | ||
issuance.issuer[].credentialSubject | Yes | Object | Credential subject; every subject must include a claim besides id. Existing id-only credentials must be re-issued. | |
issuance.issuer[].preAuthorizedCode | String | Pre-authorized code | ||
issuance.issuer[].validityDurationMs | Number | Validity duration of self-issued credentials in milliseconds. Defaults to 3 months. | 7776000000 | |
issuance.issuer[].reissueBeforeExpiryMs | Number | How long before a credential's expiry (in milliseconds) a reissue offer is sent to the holder. Defaults to 7 days. Reissuance can be disabled per credential type via the issue configuration's canReIssue flag. | 604800000 | |
DCPHolderConfig | ||||
issuance.dcp | DCPHolderConfig[] | DCP Holder configuration | [] | |
issuance.dcp[].tenantSlug | String | Tenant slug that acts as holder/claimer (multi-tenant only) | ||
issuance.dcp[].preAuthorizedCode | Yes | String | Pre-authorized code | |
issuance.dcp[].issuerId | Yes | String | DID identifier of the issuer | |
issuance.dcp[].credentialType | Yes | String | Credential type to be issued | |
issuance.dcp[].preferredProofType | Preferred proof type for the credential | "jwt" | ||
OID4VCIHolderConfig | ||||
issuance.oid4vci | OID4VCIHolderConfig[] | OID4VCI Holder configuration | [] | |
issuance.oid4vci[].tenantSlug | String | Tenant slug that acts as holder/claimer (multi-tenant only) | ||
issuance.oid4vci[].preAuthorizedCode | Yes | String | Pre-authorized code | |
issuance.oid4vci[].issuerUrl | Yes | URL | Root URL of the issuer | |
issuance.oid4vci[].credentialType | Yes | String | Credential type(s) to be issued | |
issuance.statusListCount | Number | Maximum number of status list entries per StatusListCredential | 1000 | |
DidServiceConfig | ||||
didServices | DidServiceConfig[] | DID service configurations | [] | |
didServices[].id | Yes | String | ID of the service | |
didServices[].type | Yes | String | Type of the service | |
didServices[].serviceEndpoint | Yes | URL | Service endpoint | |
DcpStsConfig | ||||
dcpSts | DcpStsConfig | DCP self-issued token configuration | ||
dcpSts.tokenTtlSeconds | Number | Lifetime of DCP self-issued tokens in seconds | 300 | |
DcpConfig | ||||
dcp | DcpConfig | DCP interoperability settings | ||
dcp.allowMissingPresentationAudience | Boolean | Allow DCP presentation responses without an audience (EDC interoperability relaxation) | false | |
InteropConfig | ||||
interop | InteropConfig | Interoperability settings | ||
EdcInteropConfig | ||||
interop.edc | EdcInteropConfig | EDC interoperability settings | ||
interop.edc.statusListVcClaim | Boolean | Accept status-list JWTs that carry the credential in a vc claim (workaround, disabled by default) | false | |
RuntimeConfig | ||||
runtime | Yes | RuntimeConfig | Runtime configuration | |
runtime.title | String | Title of the wallet | ||
runtime.acceptUnauthenticatedCredentialRequests | Boolean | Accept unauthenticated credential requests | false | |
runtime.issueMobileCredentials | Boolean | Issue mobile credentials | false | |
runtime.issueDebugCredentials | Boolean | Issue debug credentials | false | |
runtime.color | String | Primary color of the wallet | "#3B8BF6" | |
runtime.lightThemeUrl | String | Light theme logo URL | ||
runtime.darkThemeUrl | String | Dark theme logo URL | ||
DidConfig | ||||
did | DidConfig | DID configuration | ||
did.method | "did:web:" | "did:tdw:" | Provided DID method | "did:web:" | |
did.keyFormat | "JWK" | "Multikey" | Provided key format | "JWK" | |
AuditModuleConfig | ||||
audit | AuditModuleConfig | Audit logging configuration | ||
audit.enabled | Boolean | Enable audit logging | true | |
audit.minSeverity | "debug" | "info" | "warning" | "error" | "critical" | Minimum severity level to log | "info" | |
audit.logDenied | Boolean | Always log denied access attempts regardless of action type | true | |
audit.logDelegated | Boolean | Log delegated access attempts when enabled, while still respecting action-specific success filters | true | |
audit.logMutations | Boolean | Log successful mutation actions (create, update, delete, manage) | true | |
audit.logExecute | Boolean | Log successful execute actions | false | |
audit.logReads | Boolean | Log successful read actions — disabled by default as reads are frequent and rarely relevant for auditing | false | |
audit.sensitiveResources | Array | Resources logged regardless of minimum severity, while still respecting action-specific success filters | ["w.key","w.credential","sso.user"] | |
AuditHandlersConfig | ||||
audit.handlers | AuditHandlersConfig | Handler configuration | ||
audit.handlers.console | Boolean | Enable console audit log handler | false | |
audit.handlers.database | Boolean | Enable database audit log handler | true | |
audit.handlers.otlp | Boolean | Enable OTLP audit log handler | false | |
OtlpAuditHandlerConfig | ||||
audit.otlp | OtlpAuditHandlerConfig | OTLP audit log handler configuration | ||
audit.otlp.url | String | OTLP HTTP logs endpoint URL | "http://localhost:4318/v1/logs" | |
audit.otlp.headers | Object | Additional HTTP headers to include in OTLP requests | ||
audit.otlp.timeoutMillis | Number | OTLP export timeout in milliseconds | 5000 | |
audit.otlp.concurrencyLimit | Number | Maximum number of concurrent OTLP export requests | 1 | |
audit.otlp.serviceName | String | Service name included on OTLP log attributes | "tsg-dsp-api" | |
audit.otlp.serviceVersion | String | Optional service version included on OTLP log attributes |