Connecting SDK to API

To connect SDK to Oz API, specify the API URL, access token, and SSL pins as shown below.

Kotlin

OzLivenessSDK.setApiConnection(OzConnection.fromServiceToken(host, token, sslPins))

Java

OzLivenessSDK.INSTANCE.setApiConnection(
        OzConnection.Companion.fromServiceToken(host, token, sslPins), 
        null
);

Please note:

• In your host application, it is recommended that you set the API address on the screen that precedes the liveness check. Setting the API URL initiates a service call to the API, which may cause excessive server load when being done at the application initialization or startup. We recommend calling the setApiConnection method once, for example, in the Application class.

• The order of SDK initialization and API connection does not matter, but both methods must be finished successfully before invoking the createStartIntent method.

Alternatively, you can use the login and password provided by your Oz Forensics account manager:

Kotlin

OzLivenessSDK.setApiConnection(
    OzConnection.fromCredentials(host, username, password, sslPins),
    statusListener(
        { token -> /* token */ },
        { ex -> /* error */ }
    )
)

Java

OzLivenessSDK.INSTANCE.setApiConnection(
        OzConnection.Companion.fromCredentials(host, username, password, sslPins),
        new StatusListener<String>() {
            @Override
            public void onStatusChanged(@Nullable String s) {}
            @Override
            public void onSuccess(String token) { /* token */ }
            @Override
            public void onError(@NonNull OzException e) { /* error */ }
        }
);

Although, the preferred option is authentication via access token – for security reasons.

By default, logs are saved along with the analyses' data. If you need to keep the logs distinct from the analysis data, set up the separate connection for telemetry as shown below:

Kotlin

OzLivenessSDK.setEventsConnection(
    OzConnection.fromCredentials(
        "https://echo.cdn.ozforensics.com/",
        "<[e-mail]>",
        "your_telemetry_password"
    )
)

Java

OzLivenessSDK.setEventsConnection(
        OzConnection.fromCredentials(
                "https://tm.ozforensics.com/",
                "<[e-mail]>",
                "your_telemetry_password"
        )
);

Clearing authorization:

Kotlin

OzLivenessSDK.setApiConnection(null)

Java

OzLivenessSDK.INSTANCE.setApiConnection(null, null);

Other methods

Check for the presence of the saved Oz API access token:

Kotlin

val isLoggedIn = OzLivenessSDK.isLoggedIn

Java

boolean isLoggedIn = OzLivenessSDK.INSTANCE.isLoggedIn();

LogOut:

Kotlin

OzLivenessSDK.logout()

Java

OzLivenessSDK.INSTANCE.logout();