multipaz/org.multipaz.documenttype/DocumentType

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

Builder

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

Builder class for class DocumentType

Properties

cannedRequests

val cannedRequests: List<SingleDocumentCannedRequest>

displayName

val displayName: String

jsonDocumentType

val jsonDocumentType: JsonDocumentType?

mdocDocumentType

val mdocDocumentType: MdocDocumentType?

Functions

createKeyBoundSdJwtVcCredentialWithSampleData

suspend fun createKeyBoundSdJwtVcCredentialWithSampleData(document: Document, secureArea: SecureArea, createKeySettings: CreateKeySettings, dsKey: AsymmetricKey.X509Certified, signedAt: Instant, validFrom: Instant, validUntil: Instant, domain: String = "sdjwt", randomProvider: Random = Random): KeyBoundSdJwtVcCredential

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

createKeylessSdJwtVcCredentialWithSampleData

suspend fun createKeylessSdJwtVcCredentialWithSampleData(document: Document, dsKey: AsymmetricKey.X509Certified, signedAt: Instant, validFrom: Instant, validUntil: Instant, domain: String = "sdjwt", randomProvider: Random = Random): KeylessSdJwtVcCredential

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

createMdocCredentialWithSampleData

suspend fun createMdocCredentialWithSampleData(document: Document, secureArea: SecureArea, createKeySettings: CreateKeySettings, dsKey: AsymmetricKey.X509Certified, signedAt: Instant, validFrom: Instant, validUntil: Instant, expectedUpdate: Instant? = null, domain: String = "mdoc", randomProvider: Random = Random): MdocCredential

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