Variable default`Const`

default: {
    addCredential: ((options) => Promise<Result<string, AddMobileCredentialError>>);
    addTrustedIssuerCertificates: ((certificates) => Promise<Result<string[], AddTrustedIssuerCertificatesError>>);
    addTrustedVerifierCertificates: ((certificates) => Promise<Result<string[], AddTrustedVerifierCertificatesError>>);
    createAuthorizationSession: CreateAuthorizationSessionFunction;
    createOnlinePresentationSession: ((options) => Promise<Result<OnlinePresentationSession, CreateOnlinePresentationSessionError>>);
    createProximityPresentationSession: ((options) => Promise<Result<ProximityPresentationSession, CreateProximityPresentationSessionError>>);
    deinitialize: (() => Promise<void>);
    deleteCredential: ((credentialId) => Promise<void>);
    deleteTrustedIssuerCertificate: ((certificateId) => Promise<Result<void, DeleteTrustedIssuerCertificateError>>);
    deleteTrustedVerifierCertificate: ((certificateId) => Promise<void>);
    destroy: DestroyFunction;
    discoverCredentialOffer: DiscoverCredentialOfferFunction;
    generateDeviceKey: GenerateDeviceKeyFunction;
    getCredential: GetCredentialFunction;
    getCredentials: GetCredentialsFunction;
    getCurrentLogFilePath: ((...args) => Promise<null | string>);
    getCurrentProximityPresentationSession: (() => Promise<undefined | ProximityPresentationSession>);
    getNfcConfiguration: (() => Promise<Result<NfcConfiguration, MobileCredentialHolderError<PlatformNotSupported>>>);
    getTrustedIssuerCertificates: (() => Promise<TrustedIssuerCertificate[]>);
    getTrustedVerifierCertificates: (() => Promise<TrustedVerifierCertificate[]>);
    initialize: InitializeFunction;
    isInitialized: (() => Promise<boolean>);
    name: string;
    removeDeviceEngagementListener: (() => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>);
    retrieveCredentials: RetrieveCredentialsFunction;
    retrieveCredentialsUsingAuthorizationSession: RetrieveCredentialsUsingAuthorizationSessionFunction;
    sendProximityPresentationResponse: ((options) => Promise<Result<void, SendProximityPresentationResponseError>>);
    setDeviceEngagementListener: ((listener) => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>);
    setNfcConfiguration: ((nfcConfiguration) => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>);
    terminateProximityPresentationSession: (() => Promise<void>);
} = ...

Type declaration

addCredential: ((options) => Promise<Result<string, AddMobileCredentialError>>)
- - (options): Promise<Result<string, AddMobileCredentialError>>
  - Add a mobile credential to storage.
    Parameters
    - options: AddMobileCredentialOptions
      
      Credential addition options
    Returns Promise<Result<string, AddMobileCredentialError>>
    ID of the saved mobile credential.
    
    The following sequence of verification steps is performed, as per ISO/IEC 18013-5:2021:
    1. Device Key Validation:
      
      Ensures the device key cryptographic curve is supported by the SDK.
    2. Issuer Data Authentication:
      
      Executes the issuer's data authentication procedure defined in section 9.3.1 of ISO/IEC 18013-5:2021:
      - MSO Header Validation: Validates the certificate found in the MSO (Mobile Security Object) header.
      - Signer Certificate Verification: Verifies the Signer Certificate (as specified in Section 9.3.3 and Table B.3 of ISO/IEC 18013-5:2021).
      - IssuerAuth Digital Signature Verification: Verifies the digital signature of the IssuerAuth structure.
      - Verify Value Digest: Ensures the integrity and correctness of the value digest.
      - ValidityInfo Structure Validation: Ensures all elements in the ValidityInfo structure meet the defined standards.
    3. DocType-Specific Validation:
      
      Performs additional validation steps specific to the credential's docType.
      
      for mDLs this includes:
      - Confirms the mDL signer's certificate maximum validity period is within limits (up to 457 days).
      - Ensures the mDL signer certificate has the correct ExtKeyUsage (ISO/IEC 18013-5:2021 B.1.4).
      - Confirms the mDL signer certificate set its key usage for digital signatures exclusively.
      - Verifies the mDL signer certificate was issued from the correct location.
addTrustedIssuerCertificates: ((certificates) => Promise<Result<string[], AddTrustedIssuerCertificatesError>>)
- - (certificates): Promise<Result<string[], AddTrustedIssuerCertificatesError>>
  - Add trusted issuer certificates to storage.
    
    Issuer certificates are used to verify mDocs when they are added to storage. This function validates the issuer certificate as per the IACA profile defined in ISO/IEC 18013-5:2021, applying the additional constraint of requiring the certificate to be self-signed.
    
    The function is idempotent, meaning repeated calls to add the same issuer certificates do not result in duplicates. Instead, it returns the IDs of existing certificates stored by the SDK.
    Parameters
    - certificates: readonly string[]
      
      An array of certificates in PEM-encoded string format OR a Base64-encoded DER string.
    Returns Promise<Result<string[], AddTrustedIssuerCertificatesError>>
    An array of IDs of successfully added certificates.
addTrustedVerifierCertificates: ((certificates) => Promise<Result<string[], AddTrustedVerifierCertificatesError>>)
- - (certificates): Promise<Result<string[], AddTrustedVerifierCertificatesError>>
  - Add trusted verifier certificates to storage.
    
    Verifier certificates are used to verify the authorization request object fetched from the request URI as part of an OID4VP mDoc retrieval flow, as per Annex B of ISO/IEC 18013-7:2024.
    
    The function is idempotent, meaning repeated calls to add the same verifier certificates do not result in duplicates. Instead, it returns the IDs of existing certificates stored by the SDK.
    Parameters
    - certificates: readonly string[]
      
      A list of certificates in PEM-encoded string format OR as a Base64-encoded DER string.
    Returns Promise<Result<string[], AddTrustedVerifierCertificatesError>>
    A list of IDs of successfully added certificates.
createAuthorizationSession: CreateAuthorizationSessionFunction
createOnlinePresentationSession: ((options) => Promise<Result<OnlinePresentationSession, CreateOnlinePresentationSessionError>>)
- - (options): Promise<Result<OnlinePresentationSession, CreateOnlinePresentationSessionError>>
  - Create an online presentation session compliant with ISO 18013-7 and OpenID4VP.
    Parameters
    - options: CreateOnlinePresentationSessionOptions
    Returns Promise<Result<OnlinePresentationSession, CreateOnlinePresentationSessionError>>

createProximityPresentationSession: ((options) => Promise<Result<ProximityPresentationSession, CreateProximityPresentationSessionError>>)

(options): Promise<Result<ProximityPresentationSession, CreateProximityPresentationSessionError>>

Create a proximity based presentation session with an mDoc verifier using device retrieval as per ISO/IEC 18013-5:2021.

This function requires the calling application to have been granted the following Bluetooth-related permissions:

For iOS

The integrating application MUST have the "NSBluetoothAlwaysUsageDescription" attribute in its "info.plist" file. Failing to do so might result in a runtime application crash when calling this API.

If the application using this SDK hasn't tried to use Bluetooth before, calling this function will result in a system UI prompt asking the user to grant Bluetooth permissions to the application. If the user has denied a similar previous permission request (either when interacting with another part of the application or through a prior call to this function) the MobileCredentialHolderErrorType.BluetoothPermissionDenied error is thrown until the user explicitly grants Bluetooth permissions to the application in their OS app settings.

For Android

For Android versions R/11 (API level 30) and below:

android.permission.BLUETOOTH
android.permission.BLUETOOTH_ADMIN
android.permission.ACCESS_FINE_LOCATION
android.permission.ACCESS_COARSE_LOCATION

For Android versions S/12 (API level 31) and above:

android.permission.BLUETOOTH_SCAN
android.permission.BLUETOOTH_ADVERTISE
android.permission.BLUETOOTH_CONNECT

requestReceivedAction

In the event of an error onRequestReceived action can produce the following:

sessionTerminatedAction

sessionTerminatedAction is invoked when a session is terminated:

Termination Cause	Error Passed to `onSessionTerminated` Callback
Incoming message from verifier cannot be processed due to invalid CBOR format or a cryptography-related issue.	ProximityPresentationSessionTerminationErrorType.SessionStatusCodeSent
The verifier indicated that they cannot process a message from the holder due to invalid CBOR format or a cryptography-related issue.	ProximityPresentationSessionTerminationErrorType.SessionStatusCodeReceived
The holder terminates the session by calling `terminateSession()`.	`null`
The verifier terminates the session.	`null`
BLE connection lost	ProximityPresentationSessionTerminationErrorType.DataTransportDisconnected
Session timeout	ProximityPresentationSessionTerminationErrorType.InactivitySessionTimedOut

Parameters

options: CreateProximityPresentationSessionOptions

Session creation options

Returns Promise<Result<ProximityPresentationSession, CreateProximityPresentationSessionError>>

deinitialize: (() => Promise<void>)
- - (): Promise<void>
  - Deinitialize the MobileCredentialHolder SDK.
    
    This function will terminate the current presentation session if it exists and close access to storage. Calling this method when the SDK is already deinitialized will be ignored.
    
    Returns Promise<void>
deleteCredential: ((credentialId) => Promise<void>)
- - (credentialId): Promise<void>
  - Delete a credential from storage.
    
    This function deletes a credential and its corresponding device key from the storage. It is idempotent, meaning calls to delete credentials that do not exist will not return an error.
    Parameters
    - credentialId: string
      
      The ID of the credential to delete.
    Returns Promise<void>
deleteTrustedIssuerCertificate: ((certificateId) => Promise<Result<void, DeleteTrustedIssuerCertificateError>>)
- - (certificateId): Promise<Result<void, DeleteTrustedIssuerCertificateError>>
  - Delete a trusted issuer certificate from storage.
    
    This function is idempotent. Deleting a certificate that does not exist will return Ok.
    Parameters
    - certificateId: string
      
      ID of the certificate to be deleted.
    Returns Promise<Result<void, DeleteTrustedIssuerCertificateError>>
deleteTrustedVerifierCertificate: ((certificateId) => Promise<void>)
- - (certificateId): Promise<void>
  - Delete a trusted verifier certificate from storage.
    
    This function is idempotent. Deleting a certificate that does not exist will return Ok.
    Parameters
    - certificateId: string
      
      ID of certificate to be deleted.
    Returns Promise<void>
destroy: DestroyFunction
discoverCredentialOffer: DiscoverCredentialOfferFunction
generateDeviceKey: GenerateDeviceKeyFunction
getCredential: GetCredentialFunction
getCredentials: GetCredentialsFunction
getCurrentLogFilePath: ((...args) => Promise<null | string>)
- - (...args): Promise<null | string>
  - Gets the path to the Holder SDK log file.
    Parameters
    - Rest ...args: [] | [{
      appGroup?: string;
      }]
    Returns Promise<null | string>
    A Promise resolving to the log file path string, or null if no log is available.
getCurrentProximityPresentationSession: (() => Promise<undefined | ProximityPresentationSession>)
- - (): Promise<undefined | ProximityPresentationSession>
  - Get the current proximity presentation session.
    
    Returns Promise<undefined | ProximityPresentationSession>
getNfcConfiguration: (() => Promise<Result<NfcConfiguration, MobileCredentialHolderError<PlatformNotSupported>>>)
- - (): Promise<Result<NfcConfiguration, MobileCredentialHolderError<PlatformNotSupported>>>
  - Retrieve the currently persisted NFC configuration.
    
    If none was previously stored, a default configuration is returned and persisted.
    
    Returns Promise<Result<NfcConfiguration, MobileCredentialHolderError<PlatformNotSupported>>>
getTrustedIssuerCertificates: (() => Promise<TrustedIssuerCertificate[]>)
- - (): Promise<TrustedIssuerCertificate[]>
  - Retrieve all trusted issuer certificates from storage.
    
    Returns Promise<TrustedIssuerCertificate[]>
getTrustedVerifierCertificates: (() => Promise<TrustedVerifierCertificate[]>)
- - (): Promise<TrustedVerifierCertificate[]>
  - Retrieve all trusted verifier certificates from storage.
    
    Returns Promise<TrustedVerifierCertificate[]>
initialize: InitializeFunction
isInitialized: (() => Promise<boolean>)
- - (): Promise<boolean>
  - Returns Promise<boolean>
name: string
removeDeviceEngagementListener: (() => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>)
- - (): Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>
  - Removes the current device engagement listener. If no listener is registered, does nothing. NFC is only supported on Android. On any other platform, it will return NfcError.PlatformNotSupported.
    
    Returns Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>
retrieveCredentials: RetrieveCredentialsFunction
retrieveCredentialsUsingAuthorizationSession: RetrieveCredentialsUsingAuthorizationSessionFunction
sendProximityPresentationResponse: ((options) => Promise<Result<void, SendProximityPresentationResponseError>>)
- - (options): Promise<Result<void, SendProximityPresentationResponseError>>
  - Parameters
    - options: SendProximityPresentationSessionOptions
    Returns Promise<Result<void, SendProximityPresentationResponseError>>
setDeviceEngagementListener: ((listener) => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>)
- - (listener): Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>
  - Sets Listener to be called when NFC device engagement occurs. If the listener is invoked with error, then NFC engagement encountered an error (and can usually be retried). If error is undefined, then engagement was successful and the device engagement data is buffered in memory. Start a presentation from this engagement using;
```
createProximityPresentationSession({
 // ...other options
 engagementFromNfc: true,
});
```
    NFC is only supported on Android. On any other platform, it will return NfcError.PlatformNotSupported.
    Parameters
    - listener: Listener
    Returns Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>
setNfcConfiguration: ((nfcConfiguration) => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>)
- - (nfcConfiguration): Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>
  - Persist a new NFC configuration to be applied for subsequent device engagements.
    
    Does not affect any ongoing engagement sessions.
    Parameters
    - nfcConfiguration: NfcConfiguration
      
      Desired NFC behavior (handover mode, BLE mode, log level).
    Returns Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>
terminateProximityPresentationSession: (() => Promise<void>)
- - (): Promise<void>
  - Terminate the session explicitly, send status code sessionTerminated to the holder, and close data transport.
    
    Returns Promise<void>

Variable defaultConst

Type declaration

addCredential: ((options) => Promise<Result<string, AddMobileCredentialError>>)

Parameters

options: AddMobileCredentialOptions

Returns Promise<Result<string, AddMobileCredentialError>>

addTrustedIssuerCertificates: ((certificates) => Promise<Result<string[], AddTrustedIssuerCertificatesError>>)

Parameters

certificates: readonly string[]

Returns Promise<Result<string[], AddTrustedIssuerCertificatesError>>

addTrustedVerifierCertificates: ((certificates) => Promise<Result<string[], AddTrustedVerifierCertificatesError>>)

Parameters

certificates: readonly string[]

Returns Promise<Result<string[], AddTrustedVerifierCertificatesError>>

createAuthorizationSession: CreateAuthorizationSessionFunction

createOnlinePresentationSession: ((options) => Promise<Result<OnlinePresentationSession, CreateOnlinePresentationSessionError>>)

Parameters

options: CreateOnlinePresentationSessionOptions

Returns Promise<Result<OnlinePresentationSession, CreateOnlinePresentationSessionError>>

createProximityPresentationSession: ((options) => Promise<Result<ProximityPresentationSession, CreateProximityPresentationSessionError>>)

For iOS

For Android

requestReceivedAction

sessionTerminatedAction

Parameters

options: CreateProximityPresentationSessionOptions

Returns Promise<Result<ProximityPresentationSession, CreateProximityPresentationSessionError>>

deinitialize: (() => Promise<void>)

Returns Promise<void>

deleteCredential: ((credentialId) => Promise<void>)

Parameters

credentialId: string

Returns Promise<void>

deleteTrustedIssuerCertificate: ((certificateId) => Promise<Result<void, DeleteTrustedIssuerCertificateError>>)

Parameters

certificateId: string

Returns Promise<Result<void, DeleteTrustedIssuerCertificateError>>

deleteTrustedVerifierCertificate: ((certificateId) => Promise<void>)

Parameters

certificateId: string

Returns Promise<void>

destroy: DestroyFunction

discoverCredentialOffer: DiscoverCredentialOfferFunction

generateDeviceKey: GenerateDeviceKeyFunction

getCredential: GetCredentialFunction

getCredentials: GetCredentialsFunction

getCurrentLogFilePath: ((...args) => Promise<null | string>)

Parameters

Rest ...args: [] | [{ appGroup?: string; }]

Returns Promise<null | string>

getCurrentProximityPresentationSession: (() => Promise<undefined | ProximityPresentationSession>)

Returns Promise<undefined | ProximityPresentationSession>

getNfcConfiguration: (() => Promise<Result<NfcConfiguration, MobileCredentialHolderError<PlatformNotSupported>>>)

Returns Promise<Result<NfcConfiguration, MobileCredentialHolderError<PlatformNotSupported>>>

getTrustedIssuerCertificates: (() => Promise<TrustedIssuerCertificate[]>)

Returns Promise<TrustedIssuerCertificate[]>

getTrustedVerifierCertificates: (() => Promise<TrustedVerifierCertificate[]>)

Returns Promise<TrustedVerifierCertificate[]>

initialize: InitializeFunction

isInitialized: (() => Promise<boolean>)

Returns Promise<boolean>

name: string

removeDeviceEngagementListener: (() => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>)

Returns Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>

retrieveCredentials: RetrieveCredentialsFunction

retrieveCredentialsUsingAuthorizationSession: RetrieveCredentialsUsingAuthorizationSessionFunction

sendProximityPresentationResponse: ((options) => Promise<Result<void, SendProximityPresentationResponseError>>)

Parameters

options: SendProximityPresentationSessionOptions

Returns Promise<Result<void, SendProximityPresentationResponseError>>

setDeviceEngagementListener: ((listener) => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>)

Parameters

listener: Listener

Returns Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>

setNfcConfiguration: ((nfcConfiguration) => Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>)

Parameters

nfcConfiguration: NfcConfiguration

Returns Promise<Result<void, MobileCredentialHolderError<PlatformNotSupported>>>

terminateProximityPresentationSession: (() => Promise<void>)

Returns Promise<void>

Variable default`Const`

`Rest` ...args: [] | [{
appGroup?: string;
}]