multipaz-provisioning-api/org.multipaz.provisioning/DocumentConfiguration

DocumentConfiguration

data class DocumentConfiguration(val displayName: String, val typeDisplayName: String, val cardArt: ByteArray, val requireUserAuthenticationToViewDocument: Boolean, val mdocConfiguration: MdocDocumentConfiguration?, val sdJwtVcDocumentConfiguration: SdJwtVcDocumentConfiguration?, val directAccessConfiguration: DirectAccessDocumentConfiguration?)

The configuration data for a specific document.

This is made available by the issuer after identifying and proofing the application and the data in here may contain data specific to the application.

Constructors

Link copied to clipboard
constructor(displayName: String, typeDisplayName: String, cardArt: ByteArray, requireUserAuthenticationToViewDocument: Boolean, mdocConfiguration: MdocDocumentConfiguration?, sdJwtVcDocumentConfiguration: SdJwtVcDocumentConfiguration?, directAccessConfiguration: DirectAccessDocumentConfiguration?)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val cardArt: ByteArray

Card-art for the document.

Link copied to clipboard
val directAccessConfiguration: DirectAccessDocumentConfiguration?

If not null, credentials of type DirectAccessCredential are available and this object contains more information and data related to this.

Link copied to clipboard
val displayName: String

Display-name for the document e.g. "Erika's Driving License".

Link copied to clipboard
val mdocConfiguration: MdocDocumentConfiguration?

If not null, credentials of type MdocCredential are available and this object contains more information and data related to this.

Link copied to clipboard
val requireUserAuthenticationToViewDocument: Boolean

If true, require that the user authenticates to view document information.

Link copied to clipboard
val sdJwtVcDocumentConfiguration: SdJwtVcDocumentConfiguration?

If not null, credentials of type SdJwtVcCredential are available and this object contains more information and data related to this.

Link copied to clipboard
val typeDisplayName: String

Display-name for the type e.g. "Driving License".