One Logo Pool Ball
IdentityDocumentServices · IOS API REFERENCE

MobileDocumentRegistration

struct · iOS 26.0+ · SDK 27.1

struct MobileDocumentRegistration

A type used for registering mobile documents. Mobile documents, or "mdocs", are a document format defined in ISO 18013-5.

Members (12)

init · iOS 27.0+

init

TypeScript
static initMobileDocumentTypeSupportedIssuerKeyIdentifiersSupportedAuthorityKeyIdentifiersDocumentIdentifierInvalidationDate(mobileDocumentType: string, supportedIssuerKeyIdentifiers: Array<ArrayBuffer>, supportedAuthorityKeyIdentifiers: Array<ArrayBuffer>, documentIdentifier?: string, invalidationDate?: (globalThis.Date) | null): MobileDocumentRegistration
Swift declaration
init(mobileDocumentType: String, supportedIssuerKeyIdentifiers: [Data], supportedAuthorityKeyIdentifiers: [Data], documentIdentifier: String = UUID().uuidString, invalidationDate: Date? = nil)

Initialize a mobile document registration with issuer key identifiers. - Parameters: - mobileDocumentType: The type of the mobile document. - supportedIssuerKeyIdentifiers: A list of X.509 authority key identifiers that correspond to the document signer certificate chain for the mobile document. - supportedAuthorityKeyIdentifiers: A list of authority key identifiers that correspond to relying party authorizers that are trusted by the document provider app. - documentIdentifier: An identifier that uniquely refers to the document that is registered. If not provided, a random unique identifier will be chosen. - invalidationDate: A date that indicates when this registration should be invalidated. This can be used in scenarios where the expiration time period of a document is known.

init · iOS 26.0+

init

TypeScript
static initMobileDocumentTypeSupportedAuthorityKeyIdentifiersDocumentIdentifierInvalidationDate(mobileDocumentType: string, supportedAuthorityKeyIdentifiers: Array<ArrayBuffer>, documentIdentifier?: string, invalidationDate?: (globalThis.Date) | null): MobileDocumentRegistration
Swift declaration
init(mobileDocumentType: String, supportedAuthorityKeyIdentifiers: [Data], documentIdentifier: String = UUID().uuidString, invalidationDate: Date? = nil)

Initialize a mobile document registration. - Parameters: - mobileDocumentType: The type of the mobile document. - supportedAuthorityKeyIdentifiers: A list of authority key identifiers that correspond to relying party authorizers that are trusted by the document provider app. - documentIdentifier: An identifier that uniquely refers to the document that is registered. If not provided, a random unique identifier will be chosen. - invalidationDate: A date that indicates when this registration should be invalidated. This can be used in scenarios where the expiration time period of a document is known.

get · iOS 26.0+

mobileDocumentType

TypeScript
get mobileDocumentType(): string
Swift declaration
var mobileDocumentType: String

The type of the mobile document.

set · iOS 26.0+

mobileDocumentType

TypeScript
set mobileDocumentType(value: string)
Swift declaration
var mobileDocumentType: String

The type of the mobile document.

get · iOS 26.0+

invalidationDate

TypeScript
get invalidationDate(): (globalThis.Date) | null
Swift declaration
var invalidationDate: Date?

A date that indicates when this registration should be invalidated. This can be used in scenarios where the expiration time period of a document is known. If this is `nil`, the registration will never expire.

set · iOS 26.0+

invalidationDate

TypeScript
set invalidationDate(value: (globalThis.Date) | null)
Swift declaration
var invalidationDate: Date?

A date that indicates when this registration should be invalidated. This can be used in scenarios where the expiration time period of a document is known. If this is `nil`, the registration will never expire.

get · iOS 26.0+

documentIdentifier

TypeScript
get documentIdentifier(): string
Swift declaration
var documentIdentifier: String

An identifier that uniquely refers to the document that is registered. This identifier should be used to link this registration to the document that is stored in your app.

set · iOS 26.0+

documentIdentifier

TypeScript
set documentIdentifier(value: string)
Swift declaration
var documentIdentifier: String

An identifier that uniquely refers to the document that is registered. This identifier should be used to link this registration to the document that is stored in your app.

get · iOS 27.0+

supportedIssuerKeyIdentifiers

TypeScript
get supportedIssuerKeyIdentifiers(): Array<ArrayBuffer>
Swift declaration
var supportedIssuerKeyIdentifiers: [Data]

A list of X.509 authority key identifiers that correspond to the document signer certificate chain for the mobile document. An issuer key identifier is an authority key identifier from the document signer certificate chain. - Warning: The number of issuer key identifiers must not exceed 1,000 and the size of each identifier must not exceed 64 bytes.

set · iOS 27.0+

supportedIssuerKeyIdentifiers

TypeScript
set supportedIssuerKeyIdentifiers(value: Array<ArrayBuffer>)
Swift declaration
var supportedIssuerKeyIdentifiers: [Data]

A list of X.509 authority key identifiers that correspond to the document signer certificate chain for the mobile document. An issuer key identifier is an authority key identifier from the document signer certificate chain. - Warning: The number of issuer key identifiers must not exceed 1,000 and the size of each identifier must not exceed 64 bytes.

get · iOS 26.0+

supportedAuthorityKeyIdentifiers

TypeScript
get supportedAuthorityKeyIdentifiers(): Array<ArrayBuffer>
Swift declaration
var supportedAuthorityKeyIdentifiers: [Data]

A list of authority key identifiers that correspond to relying party authorizers that are trusted by the document provider app. A relying party that has been authorized by an authority listed here will be allowed to receive this document during a presentment.

set · iOS 26.0+

supportedAuthorityKeyIdentifiers

TypeScript
set supportedAuthorityKeyIdentifiers(value: Array<ArrayBuffer>)
Swift declaration
var supportedAuthorityKeyIdentifiers: [Data]

A list of authority key identifiers that correspond to relying party authorizers that are trusted by the document provider app. A relying party that has been authorized by an authority listed here will be allowed to receive this document during a presentment.

Skipped declarations

No declarations were skipped in this snapshot.

All IdentityDocumentServices types →