DocumentType

Class representing the metadata of a Document Type.

Currently ISO mdoc and JSON-based data models are supported. More document formats may be added in the future.

A Document Type has different attributes. Each attribute has a displayName which is short (1-3 words) and suitable for displaying in the UI. There is also a description which is a longer description of the attribute, typically no more than one paragraph.

Parameters

displayName

the name suitable for display, e.g. "Driving License".

cannedRequests

sample DocumentCannedRequest for the Document Type.

mdocDocumentType

metadata of a ISO mdoc Document Type (optional).

jsonDocumentType

metadata of a JSON-based Document Type (optional).

Types

Link copied to clipboard
data class Builder(val displayName: String, var mdocBuilder: MdocDocumentType.Builder? = null, var jsonBuilder: JsonDocumentType.Builder? = null)

Builder class for class DocumentType

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun createMdocCredentialWithSampleData(document: Document, secureArea: SecureArea, createKeySettings: CreateKeySettings, dsKey: EcPrivateKey, dsCertChain: X509CertChain, signedAt: Instant, validFrom: Instant, validUntil: Instant, expectedUpdate: Instant? = null, domain: String = "mdoc"): MdocCredential

Adds a MdocCredential to a Document with sample data for the document type.