walletsdk/com.dewa.walletsdk.api/IssuedDocumentHandle

IssuedDocumentHandle

class IssuedDocumentHandle

High–level stable representation of a stored credential/document.

Backed by EUDI IssuedDocument, but exposes only stable and safe-to-use properties for apps:

document id
display name / issuer name
SD-JWT VC payload
optional VCT type metadata
optional rendered SVG card templates with claim placeholders resolved
signing using holder key

More structured parsing (e.g. credentialSubject.name) is handled at the app layer or via helpers such as vcValue.

When com.dewa.walletsdk.WalletSdkOptions.trustedTypeMetadataRegistries is configured, the SDK attempts to enrich issued documents with VCT metadata and localized rendering templates. This enrichment is optional and cached by the SDK, so metadata and renderingBundle may be null if no metadata registry is configured, the credential type has no metadata, or remote fetching failed.

Properties

credentialSubjectJson

val credentialSubjectJson: JsonObject?

val data: SdJwtVcData?

Strongly-typed SD-JWT VC data when applicable.

val displayName: String

Human-readable name resolved from issuer metadata or format.

val format: String

Raw document format name (e.g. "SdJwtVcFormat(ES256, ...)").

Unique document ID inside the wallet database.

val issuerName: String

Issuer display name (falls back to "Unknown issuer").

val metadata: VctTypeMetadataDTO?

Optional VCT metadata fetched from a trusted type metadata registry.

recreatedClaims

val recreatedClaims: JsonObject?

renderingBundle

val renderingBundle: CredentialRenderingBundle?

Optional localized SVG templates with placeholders already replaced from the reconstructed SD-JWT VC claims.

val sdJwtVc: String?

Raw SD-JWT VC string, if available.

val vcJson: JsonObject?

val vct: String?

VCT when this document is an SD-JWT VC. Useful for registry lookups or filtering.

Functions

fun checkVct(vct: String): Boolean

Checks whether this document belongs to a specific VCT.

suspend fun credSdJwt(): String

suspend fun getCredentials(): SecureAreaBoundCredential

Retrieves the wallet-bound credential associated with this document.

fun getIdBirthDate(): String?

fun getIdentity(): String?

fun getIdFullName(): String?

getRemainingUses

suspend fun getRemainingUses(): Int

suspend fun sign(dataToSign: ByteArray, unlockReason: Reason = Reason.Unspecified): EcSignature

signConsumingCredential

suspend fun signConsumingCredential(signingInput: ByteArray): EcSignature

Signs arbitrary input using the consuming credential key.