multipaz/org.multipaz.document/DocumentStore/createDocument

createDocument

suspend fun createDocument(displayName: String? = null, typeDisplayName: String? = null, cardArt: ByteString? = null, issuerLogo: ByteString? = null, authorizationData: ByteString? = null, appData: ByteString? = null, created: Instant = Clock.System.now(), readerIdentifiers: List<ByteString> = emptyList(), metadata: AbstractDocumentMetadata? = null): Document

Creates a new document.

Return

A newly created document.

Parameters

displayName

User-facing name of this specific Document instance, e.g. "John's Passport", or null.

typeDisplayName

User-facing name of this document type, e.g. "Utopia Passport", or null.

cardArt

An image that represents this document to the user in the UI. Generally, the aspect ratio of 1.586 is expected (based on ID-1 from the ISO/IEC 7810). PNG format is expected and transparency is supported.

issuerLogo

An image that represents the issuer of the document in the UI, e.g. passport office logo. PNG format is expected, transparency is supported and square aspect ratio is preferred.

authorizationData

Saved authorization data to refresh credentials, possibly without requiring user to re-authorize.

appData

Application-specific data.

created

The time the document was created.

readerIdentifiers

A list of reader identifiers for reader authentication.

metadata

initial value for Document.metadata