Exposed APIs of the Orchestration SDK: Local Authentication

New APIs are created for Swift users of the iOS SDK. For more information, refer to the Xcode API documentation on LocalAuthenticationParameters and LocalAuthenticationDelegate.

The Customer Mobile Application can initialize a local authentication process by calling the startLocalAuthentication method of the Orchestrator object.

A LocalAuthenticationParams object must be provided as an input parameter of the startLocalAuthentication method; this LocalAuthenticationParams object must be initiated with the following parameters:

• User identifier. A string which uniquely identifies the user on the OneSpan Trusted Identity platform.

• Cryptographic Application Index. The index of the cryptographic application which must be used to generate the OTP.

• (OPTIONAL) Challenge. A string which can be used to diversify the OTP generation. If the crypto-app index is related to a Challenge/Response application, a challenge parameter must be provided.

• Protection Type. The authentication method which must be used to authenticate the user before the OTP is generated (see Authentication methods for more information).

• An object implementing the LocalAuthenticationCallback interface.

The LocalAuthenticationCallback interface is used by the Orchestration SDK to interact with the Customer Mobile Application during the local authentication process. It exposes the following methods:

• onLocalAuthenticationSuccess: Called upon local authentication success. It returns the generated OTP and, depending on the Digipass configuration, a host code (used to authenticate the authentication server on which the OTP has been submitted).

• onLocalAuthenticationAborted: Called when local authentication is canceled.

• onLocalAuthenticationPasswordError: Called upon a local authentication process error due to incorrect user input. The possible errors are listed in the OrchestrationErrorCodes class.

For more information about this feature, see Local authentication.