Checking Liveness and Face Biometry

If you use our SDK just for capturing videos, omit this step.

OzCapsula (SDK v8.22 and newer)

Send the encrypted container to your own backend as raw bytes (application/octet-stream). Your backend forwards it to Oz API and returns the analysis response.

Do not run the analysis directly from the mobile SDK. In the embedded-SDK integration flow, the analysis call must go through your own backend.

The code below is illustrative – YourBackend.uploadOzContainer(...) is not part of Oz SDK. You implement this method yourself in your own backend client; Oz SDK does not provide an upload helper for this integration path.

private fun handleContainer(container: DataContainer?) {
    if (container == null) return

    YourBackend.uploadOzContainer(
        container = container.getBytes(),
        contentType = "application/octet-stream"
    )
}

Your backend submits the container to Oz API in a single synchronous POST request as shown here.

Legacy way: the run method (direct SDK ↔ API interaction). Warning: this method is less secure than using your backend as an intermediary, as described above.

At the Capturing Videos step, you've created a data container with all the required information in it , so now just send it to analysis using the addContainer(container) and run methods.

Kotlin

private fun runAnalysis(container: DataContainer?) {
    if (container == null) return
    AnalysisRequest.Builder()
        .addContainer(container)
        .build()
        .run(
            { result ->
                val isSuccess = result.analysisResults.all { it.resolution == Resolution.SUCCESS }
            },
            { /* show error */ },
            { /* update status */ },
        )
}

SDK 8.21 and older

To check liveness and face biometry, you need to upload media to our system and then analyze them.

To interpret the results of analyses, please refer to Types of Analyses.

Here’s an example of performing a check:

Kotlin

analysisCancelable = AnalysisRequest.Builder()
 // mediaToAnalyze is an array of OzAbstractMedia that were captured or otherwise created 
    .addAnalysis(Analysis(Analysis.Type.QUALITY, Analysis.Mode.SERVER_BASED, mediaToAnalyze))// or ON_DEVICE if you want the on-device analysis
    .build()
//initiating the analyses and setting up a listener
    .run(object : AnalysisRequest.AnalysisListener {
        override fun onStatusChange(status: AnalysisRequest.AnalysisStatus) { handleStatus(status) // or your status handler
        }
        override fun onSuccess(result: RequestResult) {
            handleResults(result) // or your result handler
        }
        override fun onError(error: OzException) { handleError(error) // or your error handler 
        }
    })

Java

analysisCancelable = new AnalysisRequest.Builder()
// mediaToAnalyze is an array of OzAbstractMedia that were captured or otherwise created 
        .addAnalysis(new Analysis(Analysis.Type.QUALITY, Analysis.Mode.SERVER_BASED, mediaToAnalyze)) // or ON_DEVICE if you want the on-device analysis
        .build()
//initiating the analyses and setting up a listener
        .run(new AnalysisRequest.AnalysisListener() { 
            @Override
            public void onSuccess(@NonNull RequestResult list) { handleResults(list); } // or your result handler
            @Override
            public void onError(@NonNull OzException e) { handleError(e); } // or your error handler
            @Override
            public void onStatusChange(@NonNull AnalysisRequest.AnalysisStatus analysisStatus) { handleStatus(analysisStatus); } // or your status handler
        })

To delete media files after the checks are finished, use the clearActionVideos method.

Adding metadata

To add metadata to a folder, use the addFolderMeta method.

Kotlin

    .addFolderMeta(
        mapOf(
            "key1" to "value1",
            "key2" to "value2"
        )
    )

Java

.addFolderMeta(Collections.singletonMap("key", "value")) 

Extracting the best shot

In the params field of the Analysis structure, you can pass any additional parameters (key + value), for instance, to extract the best shot on the server side.

mapOf("extract_best_shot" to true)

Using media from another SDK

To use a media file that is captured with another SDK (not Oz Android SDK), specify the path to it in OzAbstractMedia:

       val file = File(context.filesDir, "media.mp4") // use context.getExternalFilesDir(null) instead of context.filesDir for external app storage
       val media = OzAbsractMedia.OzVideo(OzMediaTag.VideoSelfieSmile, file.absolutePath)

Adding media to a certain folder

If you want to add your media to the existing folder, use the setFolderId method:

    .setFolderId(folderId)