Skip to main content

References

This page contains references for possible error codes, object structure, etc. Most of this can be obtained from the javadoc/clicking into code via Android Studio, but it is also provided here as a reference.

SmartCapture Face Result​

Whether the Face Camera was launched via activity or via composition, its success case result is returned as a FaceCameraResult.

/**
 * A data class that wraps the result from the [FaceCamera]
 *
 * @property encryptedBlob A [ByteArray] that represents encrypted data that can be sent to the
 * biometrics server.
 * @property previewPhoto An unencrypted [Bitmap] that can be used as a preview to the user for
 * the data in the encrypted blob.
 * @property unencryptedBlob A [ByteArray] that represents the preview bitmap saved as a JPEG 
 * image at 90% quality.
 */
data class FaceCameraResult(
    val encryptedBlob: ByteArray,
    val previewPhoto: Bitmap,
    val unencryptedBlob: ByteArray
)

The encryptedBlob is what should get sent to the server, while the previewPhoto can be used for on-device preview.