A store that is used to notify the system which documents an app has available for presentment.
The information registered with this store will be used to appropriately surface your app as an option during a presentment.
When a particular document is registered, it is expected that the authorization UI provided through the app's `IdentityDocumentProvider` extension will be able to handle incoming requests for that particular document.
The app should only register documents that are active and able to be successfully presented. If a document becomes inactive, it should be unregistered from the store.
func addRegistration(_ registration: some IdentityDocumentRegistration) async throws
Register a document with the system.
If the provided registration contains a `documentIdentifier` that has already been registered, the existing registration will be replaced by the provided registration.
- Parameter registration: A registration that contains information about the document necessary to surface it appropriately during a presentment.
Unregister a particular document with the system.
When a document is unregistered, your app will no longer be surfaced as an option for responding to a presentment request for that particular document.
- Parameter documentIdentifier: The identifier of the document to unregister.
get · iOS 26.0+
registrations
TypeScript
get registrations(): Promise<Array<SDKHandle>>
Swift declaration
var registrations: [any IdentityDocumentRegistration] { get async throws }
A list of all documents that are registered with the system.
get · iOS 26.0+
unownedExecutor
TypeScript
get unownedExecutor(): SDKHandle
Swift declaration
nonisolated final var unownedExecutor: UnownedSerialExecutor { get }
Retrieve the executor for this actor as an optimized, unowned
reference.
This property must always evaluate to the same executor for a
given actor instance, and holding on to the actor must keep the
executor alive.
This property will be implicitly accessed when work needs to be
scheduled onto this actor. These accesses may be merged,
eliminated, and rearranged with other work, and they may even
be introduced when not strictly required. Visible side effects
are therefore strongly discouraged within this property.
- SeeAlso: ``SerialExecutor``
- SeeAlso: ``TaskExecutor``
get · iOS 26.0+
status
TypeScript
get status(): Promise<IdentityDocumentProviderRegistrationStore_Status>
Swift declaration
var status: IdentityDocumentProviderRegistrationStore.Status { get async }
The status of the registration store. This value should be checked before any attempts to interact with the store.
