app
root
repo
    +--com
        +--trustvision
            +--tv_api_sdk
                +--3.x.x
                    +--tv_api_sdk-3.x.x.aar
                    +--tv_api_sdk-3.x.x.pom
                maven-metadata.xml
            +--tv_core_sdk
            +--tv_sdk_client
...

buildscript {
    ext.kotlin_version = '1.6.21' // or any version that >= 1.5 and < 1.8

    repositories {
        maven {
            url 'https://maven.google.com'
        }
        mavenCentral()
        google()
    }

    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}

allprojects {
    repositories {
        maven { url "https://maven.google.com" }
        maven { url "https://jitpack.io" }
        maven { url "path/to/tvsdk/folder" }  // example : maven { url "${project.rootDir}/repo" }
        ...
    }
}

pluginManagement {
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_PROJECT)
    repositories {
        google()
        mavenCentral()
    }
}

android {
    ...
    aaptOptions {
        noCompress "tflite"
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation('com.trustvision:tv_sdk_client:3.x.x@aar') {
        transitive = true
    }
    testImplementation 'junit:junit:4.12'

}

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    TrustVisionSDK.init(context, jsonConfigurationByServer, languageCode, object : TVInitializeListener {
        override fun onInitSuccess(result: TVInitResult) {
            super.onInitSuccess(result)
        }

        override fun onInitError(error: TVDetectionError) {

        }
    })
}

TrustVisionSdk.supportedLanguages

TrustVisionSdk.changeLanguageCode(languageCode)

<resources>
    <string name="tv_title_activity_main" />
    <integer name="google_play_services_version">1</integer>
    <style name="tvAppTheme.NoActionBar" parent="AppTheme.NoActionBar" />
</resources>

TrustVisionSDK.installDynamicFeature {
    // We often execute this code to install some necessary resources for dynamic feature
    SplitCompat.installActivity(it)
}

val builder = TVIDConfiguration.Builder()
    .setCardTypes(selectedCards)
    .setCardSide(TVSDKConfiguration.TVCardSide.FRONT)
    .setReadBothSide(false)
    .setEnableSound(false)
    .setEnablePhotoGalleryPicker(false)
    .setEnableTiltChecking(false)
    .setSkipConfirmScreen(false)
    .setEnableScanNFC(true)
    .setEnableScanQr(true)

val configuration = builder.build()

listOf(
    TVCardType(
        "vn.national_id",
        "CMND cũ / CMND mới / CCCD",
        true,
        TVCardType.TVCardOrientation.HORIZONTAL
    )
)

TrustVisionSDK.startIDCapturing(activity, configuration, object : TVCapturingCallBack() {
    override fun onNewFrameBatch(frameBatch: FrameBatch) {

    }
    override fun onError(error: TVDetectionError) {

    }
    override fun onSuccess(result: TVDetectionResult) {

    }
    override fun onCanceled() {

    }
    override fun readIdCardNumber(image: TVImageClass): String? {

    }
})

// this dictionary will be used for ID Tampering Verification
val frontCardFrameBatchIdsDictionary: MutableMap<String, String> = mutableMapOf()
val backCardFrameBatchIdsDictionary: MutableMap<String, String> = mutableMapOf()
// frameBatchIdsDictionary.put(
//    key = <id_returned_from_sdk>,
//    value = <id_responded_from_server>
// )

override fun onNewFrameBatch(frameBatch: FrameBatch) {
    val gson = Gson()
    val framesStr = gson.toJson(frameBatch.frames)
    val params: MutableMap<String, Any> = HashMap()
    params["frames"] = framesStr
    params["metadata"] = frameBatch.metadata
    params["label"] = "video"
    val jsonToBeUploaded = gson.toJson(params)
    // upload frame batch to server using this api:
    // https://ekyc.trustingsocial.com/api-reference/customer-api/#upload-videoaudioframes
    val uploadingResult: YourResponseObject = yourMethodToUploadFrameBatch(jsonToBeUploaded)

    // Keep the id that generated by the SDK corresponding with the one responded from server
    if (cardSide === TVSDKConfiguration.TVCardSide.FRONT) {
        frontCardFrameBatchIdsDictionary[frameBatch.id] = uploadingResult.fileId
    } else {
        backCardFrameBatchIdsDictionary[frameBatch.id] = uploadingResult.fileId
    }
}

// These lists contain all valid frame batch ids that responded by server
var validFrontCardServerFrameBatchIds: List<String>? = null
var validBackCardServerFrameBatchIds: List<String>? = null

override fun onSuccess(result: TVDetectionResult) {
// the batch id list is null when Frame Recording feature is disabled by client settings.
// Wait until every Frame batch has been uploaded to server before calling this
    if (everyFrameBatchUploadingCompleted) {
        result.frontCardFrameBatchIds?.also {
            validFrontCardServerFrameBatchIds = removeRedundantFrameBatchIds(
                frontCardFrameBatchIdsDictionary,
                it
            )
        }
        result.backCardFrameBatchIds?.also {
            validBackCardServerFrameBatchIds = removeRedundantFrameBatchIds(
                backCardFrameBatchIdsDictionary,
                it
            )
        }
    }
}

private fun removeRedundantFrameBatchIds(
    batchIdsDictionary: MutableMap<String, String>,
    validIdsFromSDK: Collection<String>
): List<String> {
    val iter: MutableIterator<Map.Entry<String, String>> = batchIdsDictionary.entries.iterator()
    while (iter.hasNext()) {
        val (key1) = iter.next()
        if (!validIdsFromSDK.contains(key1)) {
            iter.remove()
        }
    }
    return batchIdsDictionary.values.toList()
}

var frontCardId: String? = null
var backCardId: String? = null
var frontQrId: String? = null
var backQrId: String? = null

fun onSuccess(result: TVDetectionResult) {
    // With front side
    frontCardId = result.frontCardImage?.imageByteArray?.let {
        yourMethodToUploadImage(it)
    }
    // With back side
    backCardId = result.backCardImage?.imageByteArray?.let {
        yourMethodToUploadImage(it)
    }

    // In case the QR capturing feature is enabled, and `result.getCardQrImage()` is null then
    // the user will be notified, so they can choose to re-capture their ID card.
    frontQrId = result.frontIdQr?.images?.getOrNull(i)?.imageByteArray?.let {
        yourMethodToUploadImage(it)
    }
    backQrId = result.backIdQr?.images?.getOrNull(i)?.imageByteArray?.let {
        yourMethodToUploadImage(it)
    }
}

{
  "image": {
    "id": "<frontCardId>"
  },
  "image2": {
    "id": "<backCardId>"
  },
  "qr1_images": [
    {
      "id": "<qrId>"
    }
  ],
  "card_type": "<result.cardType.getCardId()>",
  "videos": [
    {
      "id": "<validFrontCardServerFrameBatchIds.get(index)>"
    },
    {
      "id": "<validFrontCardServerFrameBatchIds.get(index + 1)>"
    },
    ...
    {
      "id": "<validBackCardServerFrameBatchIds.get(index)>"
    },
    {
      "id": "<validBackCardServerFrameBatchIds.get(index + 1)>"
    },
    ...
  ]
}

val frontQrImage = result.frontIdQr?.images?.getOrNull(i)
val metadata: Map<String,String>? = frontQrImage?.metadata
val label: String? = frontQrImage?.label
val data: ByteArray? = frontQrImage?.imageByteArray

override fun readIdCardNumber(image: TVImageClass): String? {
  var idNumber: String? = null;
  // call api or do any thing to read and return id number
  // TODO
  return idNumber;
}

val builder = TVSelfieConfiguration.Builder()
    .setCameraOption(TVSDKConfiguration.TVCameraOption.FRONT)
    .setEnableSound(false)
    .setLivenessMode(TVLivenessMode.PASSIVE)
    .setSkipConfirmScreen(false)

val configuration = builder.build()

TrustVisionSDK.startSelfieCapturing(activity, configuration, object : TVCapturingCallBack() {
    override fun onNewFrameBatch(frameBatch: FrameBatch) {

    }
    override fun onError(error: TVDetectionError) {

    }
    override fun onSuccess(result: TVDetectionResult) {

    }
    override fun onCanceled() {

    }
})

// this dictionary will be used for ID Tampering Verification
val selfieFrameBatchIdsDictionary: MutableMap<String, String> = mutableMapOf()
// frameBatchIdsDictionary.put(
//    key = <id_returned_from_sdk>,
//    value = <id_responded_from_server>
// )

override fun onNewFrameBatch(frameBatch: FrameBatch) {
    val gson = Gson()
    val framesStr = gson.toJson(frameBatch.frames)
    val params: MutableMap<String, Any> = HashMap()
    params["frames"] = framesStr
    params["metadata"] = frameBatch.metadata
    params["label"] = "video"
    val jsonToBeUploaded = gson.toJson(params)
    // upload frame batch to server using this api:
    // https://ekyc.trustingsocial.com/api-reference/customer-api/#upload-videoaudioframes
    val uploadingResult: YourResponseObject = yourMethodToUploadFrameBatch(jsonToBeUploaded)

    // Keep the id that generated by the SDK corresponding with the one responded from server
    selfieFrameBatchIdsDictionary[frameBatch.id] = uploadingResult.fileId
}

// These lists contain all valid frame batch ids that responded by server
var validServerFrameBatchIds: List<String>? = null

override fun onSuccess(result: TVDetectionResult) {
    // the batch id list is null when Frame Recording feature is disabled by client settings.
    // Wait until every Frame batch has been uploaded to server before calling this
    if (everyFrameBatchUploadingCompleted) {
        result.livenessFrameBatchIds?.also {
            validServerFrameBatchIds = removeRedundantFrameBatchIds(
                selfieFrameBatchIdsDictionary,
                it
            )
        }
    }
}

private fun removeRedundantFrameBatchIds(
    batchIdsDictionary: MutableMap<String, String>,
    validIdsFromSDK: Collection<String>
): List<String> {
    val iter: MutableIterator<Map.Entry<String, String>> = batchIdsDictionary.entries.iterator()
    while (iter.hasNext()) {
        val (key1) = iter.next()
        if (!validIdsFromSDK.contains(key1)) {
            iter.remove()
        }
    }
    return batchIdsDictionary.values.toList()
}

// These lists of image ids will be used in Liveness Verification
val frontalImageIds = mutableListOf<String>()
val gestureImageIds = mutableListOf<String>()

override fun onSuccess(result: TVDetectionResult) {
    handleSelfieImages(result.selfieImages)
}

private fun handleSelfieImages(selfieImages: List<SelfieImage>?) {
    selfieImages?.forEach { selfieImage ->
        // Handle frontal images
        selfieImage.frontalImage?.imageByteArray?.also {
            // frontalImageId is the id of the image, returned from server when the uploading API is completed successfully
            val frontalImageId = yourUploadImageMethod(it)
            frontalImageIds.add(frontalImageId)
        }

        // Handle gesture images
        selfieImage.gestureImage?.imageByteArray?.also {
            // gestureImageId is the id of the image, returned from server when the uploading API is completed successfully
            val gestureImageId = yourUploadImageMethod(it)
            gestureImageIds.add(gestureImageId)
        }
    }
}

{
  "file": "<byte[] dataToUpload>",
  "label": "<proper label, check the API document for detail>"
}

{
  "images": [
    {
      "id": "<frontalImageIds.get(index)>"
    },
    {
      "id": "<frontalImageIds.get(index + 1)>"
    },
    ...
  ]
}

{
  "gesture_images": [
    {
      "gesture": "<result.getSelfieImages().get(index).getGestureType().toGestureType().toLowerCase()>",
      "images": [
        {
          "id": "<gestureImageIds.get(index)>"
        }
      ]
    },
    {
      "gesture": "<result.getSelfieImages().get(index + 1).getGestureType().toGestureType().toLowerCase()>",
      "images": [
        {
          "id": "<gestureImageIds.get(index + 1)>"
        }
      ]
    },
    ...
  ]
}

{
  "videos": [
    {
      "id": "<validServerFrameBatchIds.get(index)>"
    },
    {
      "id": "<validServerFrameBatchIds.get(index + 1)>"
    },
    ...
  ]
}

{
  "metadata": "<result.getLivenessMetadata()>"
}

val builder = TVQRConfiguration.Builder()
    .setCardType(selectedCard)
    .setCardSide(TVSDKConfiguration.TVCardSide.FRONT)
    .setEnableSound(false)
    .setSkipConfirmScreen(false)

val configuration = builder.build()

TVCardType(
    "vn.national_id",
    "CMND cũ / CMND mới / CCCD",
    true,
    TVCardType.TVCardOrientation.HORIZONTAL
)

TrustVisionSDK.startQRScanning(activity, configuration, object : TVCapturingCallBack() {
    override fun onError(error: TVDetectionError) {

    }

    override fun onSuccess(result: TVDetectionResult) {

    }

    override fun onCanceled() {

    }

})

val frontQrImage = result.frontIdQr?.images?.getOrNull(i)
val metadata: Map<String,String>? = frontQrImage?.metadata
val label: String? = frontQrImage?.label
val data: ByteArray? = frontQrImage?.imageByteArray

val builder = TVNfcConfiguration.Builder()
    .setNfcCode(nfcCode)
    .setSOD(sod)
    .setRequestReadImageNfc(true)
    .setRequestIntegrityCheckNfc(true)
    .setRequestCloneDetectionNfc(true)
    .setNfcMaxRetries(5)

val configuration = builder.build()

TrustVisionSDK.startNfcScanning(activity, configuration, object : TVCapturingCallBack() {
    override fun onError(error: TVDetectionError) {

    }

    override fun onSuccess(result: TVDetectionResult) {

    }

    override fun onCanceled() {

    }

})

// [FlowStartingFunc]: startIdCapturing, startSelfieCapturing, startQRScanning, startNfcScanning
TrustVisionSDK.[FlowStartingFunc](activity, configuration, object : TVCapturingCallBack() {
    override fun onError(error: TVDetectionError) {
        val message = error.errorDescription
        Log.d("", message)
        showToast(message)

        ///////////////////////////////////////
        // ERROR HANDLER
        val code = error.errorCode
        val description = error.errorDescription

        when (code) {
            TVDetectionError.CONFIGURATION_ERROR -> {
                // Invalid configuration
            }
            TVDetectionError.DETECTION_ERROR_PERMISSION_MISSING -> {
                // No camera permission.
            }
            TVDetectionError.DETECTION_ERROR_CAMERA_ERROR -> {
                // The camera can't be opened.
            }
            TVDetectionError.DETECTION_ERROR_SDK_INTERNAL -> {
                // The SDK has an unexpected error.
            }
            TVDetectionError.DETECTION_ERROR_NFC -> {
                // The SDK has an unexpected error when scanning NFC
            }
        }
    }

    override fun onSuccess(result: TVDetectionResult) {

    }

    override fun onCanceled() {

    }

})

TrustVisionSDK.isNfcSupport(Context): Boolean

int NEUTRAL = 1
int TURN_LEFT = 5
int TURN_RIGHT = 6
int FACE_UP = 7
int FACE_DOWN = 8

int TVDetectionError.DETECTION_ERROR_PERMISSION_MISSING = 1004
int TVDetectionError.DETECTION_ERROR_CAMERA_ERROR = 1005
int TVDetectionError.DETECTION_ERROR_SDK_INTERNAL = 1007

private fun customizeTVCommonThemes() {
    // Common Title label theme
    val titleLabelThemeDefault = titleLabelTheme
    titleLabelThemeDefault.font = your_font
    // there are more to be customized...

    // Common Normal label theme
    val normalLabelThemeDefault = normalLabelTheme
    normalLabelThemeDefault.textSize = your_text_size
    // there are more to be customized...

    // Common Instruction label theme
    val instructionLabelTheme = instructionLabelTheme
    instructionLabelTheme.textColor = your_text_color
    // there are more to be customized...

    // Common Error label theme
    val errorLabelThemeDefault = errorLabelTheme
    errorLabelThemeDefault.cornerRadius = your_corner_radius
    // there are more to be customized...

    // Common Timeout label theme
    val timeoutLabelThemeDefault = timeoutLabelTheme
    timeoutLabelThemeDefault.backgroundColors = your_background_colors
    // there are more to be customized...
}

private fun initTVTheme(): TVTheme {
    val customizedTheme = TVTheme()

    // Selfie capturing screen
    customizedTheme.selfieCapturingTheme.gestureTheme.lookStraightActiveImage = your_image
    // there are more to be customized...

    // Selfie confirmation screen
    customizedTheme.selfieConfirmationTheme.retryButtonImage = your_image
    // there are more to be customized...

    // Id capturing screen
    customizedTheme.idCapturingTheme.maskViewNeutralImage = your_image
    // there are more to be customized...

    // Id confirmation screen
    customizedTheme.idConfirmationTheme.closeButtonImage = your_image
    // there are more to be customized...

    // QR guideline popup
    customizedTheme.qrGuidelinePopupTheme.headerImage = your_image
    // there are more to be customized...

    // QR guideline popup
    customizedTheme.qrRetryPopupTheme.backgroundColor = your_color
    // there are more to be customized...
    return customizedTheme
}